RevelaNetwork/Revela-Frontend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

cooler readme with more steps

Browse source
This commit is contained in:
David Reed 2022-09-15 17:52:04 -04:00
parent 83669f9a4a
commit 383fd6b352
1 changed files with 36 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -1,7 +1,41 @@
# Ultraviolet-Static
<p align="center"><img src="https://raw.githubusercontent.com/titaniumnetwork-development/Ultraviolet-Static/main/public/uv.png" height="200"></p>
<h1 align="center">Ultraviolet-Static</h1>
Static files/assets used to spin up an Ultraviolet website.
## Packaging
Run `npm pack` to produce a tgz containing the assets as an NPM package.
1. Clone the repository
```sh
$ git clone https://github.com/titaniumnetwork-development/Ultraviolet-Static.git
> Cloning into Ultraviolet-Static...
$ cd Ultraviolet-Static
```
2. Install dependencies
```sh
npm install
```
3. Make your changes...
4. Produce the `dist/` directory and import the Ultraviolet scripts
```sh
npm run build
```
5. Package for NPM to produce `ultraviolet-static.X.X.X.tar.gz` file
```sh
npm pack
```
## Install in [Ultraviolet-Node](https://github.com/titaniumnetwork-development/Ultraviolet-Node.git)
1. Follow installation steps until you need to run `npm install`
2. Install the produced Ultraviolet-Static tgz (upload to Discord, Github, etc...) (see [Packaging](#packaging))
```sh
$ npm install https://github.com/titaniumnetwork-development/Ultraviolet-Static/releases/download/v1.0.0/ultraviolet-static-1.0.0.tgz
# OR
$ npm install ../path/to/ultraviolet-static-1.0.0.tgz
```
3. Continue instructions...
```sh
$ npm start
```