Skip to content

Commit c22b4d3

Browse files
committed
updated readme
Signed-off-by: Tobias Winkler <[email protected]>
1 parent c34756e commit c22b4d3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
11
# Devilbox Web UI
2+
3+
## Installation
4+
5+
Please install [nvm](https://github.com/nvm-sh/nvm) beforehand.
6+
7+
1. clone repository
8+
2. cd into project
9+
3. run `nvm use`, if you get an error that the node version does not exit yet then please follow the instructions on screen (the `nvm use` is included in the installation)
10+
4. run `npm install`
11+
12+
## Building
13+
14+
Run `npm run build` to get the production ready build, which is being put under `./build`.
15+
16+
If you want an ad hoc server serving the latest build then run `npm run start:build` instead - it will run the build command and then serve the application from that folder.
17+
18+
## Development
19+
20+
Run `npm run start` to get the ad hoc server running.

0 commit comments

Comments
 (0)