add .dockerignore, add Dockerfile, add default.nix, udpate README.md, move packages into respective category(dev/production)
This commit is contained in:
21
README.md
21
README.md
@@ -1,13 +1,32 @@
|
||||
# SlowDowner
|
||||
music web player with slowdown option
|
||||
|
||||
## System Dependendies
|
||||
### Ubuntu/Debian (apt)
|
||||
TODO
|
||||
|
||||
### NixOS
|
||||
If you have the nix package manager or are running NixOS you can install all dependencies with
|
||||
``` nix-shell ```
|
||||
(This will try to start zsh in the end. Comment the line out if you use bash)
|
||||
|
||||
## Dependencies
|
||||
### Yarn
|
||||
This project uses Yarn as package manager, to install all needed dependencies run
|
||||
``` yarn ```
|
||||
``` yarn install ```
|
||||
in the project directory
|
||||
|
||||
### Building
|
||||
To build the static files run
|
||||
```yarn run build```
|
||||
this will create the folder ```dist``` with all static files.
|
||||
then you can run
|
||||
```yarn run start```
|
||||
to run the server locally
|
||||
or use the provided Dockerfile to create a dockerimage like this
|
||||
```docker build -t slowdowner:v3```
|
||||
for example
|
||||
|
||||
### Development
|
||||
to run the test server locally run
|
||||
``` yarn run start ```
|
||||
|
||||
Reference in New Issue
Block a user