Files
slowdowner/README.md
2022-05-29 14:03:34 +00:00

36 lines
990 B
Markdown

# SlowDowner
music web player with slowdown option
## System Dependencies
### Ubuntu/Debian (apt)
install nodejs and yarn (should also work with raw npm).
### 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 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:v{X} .```
for example
### Development
to run the test server locally run
``` yarn run start ```
and in another terminal
``` yarn run dev ```
to build and watch the static frontend files