Dymas/jarri-spooty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs(site): added build from source description to site documentation

Browse Source 
#3
This commit is contained in:
raiper34
2024-10-13 22:11:31 +02:00
parent b4bfe6c813
commit 5051afa012
3 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source.md
+23 -1
View File
@@ -1,3 +1,25 @@
# Build from source
TODO
Spooty can be also build from source files on your own.
### Requirements
- Node v18.19.1 (it is recommended to use `nvm` node version manager to install proper version of node)
### Process
- install Node v18.19.1 using `nvm install` and use that node version `nvm use`
- from project root install all dependencies using `npm install`
- copy `.env.default` as `.env` in `src/backend` folder and modify desired environment properties (see list below)
- build source files `npm run build`
- built project will be stored in `dist` folder
- start server `npm run start`
### `.env` environment variables
some behaviour and settings of Spooty can be configured using environment variables and `.env` file.
Name | Default | Description |
--- |--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
DB_PATH | `./config/db.sqlite` (relative to backend) | Path where Spooty database will be stored |
FE_PATH | `../frontend/browser` (relative to backend) | Path to frontend part of application |
DOWNLOADS_PATH | `./downloads` (relative to backend) | Path where downaloded files will be stored |
FORMAT | `mp3` | Format of downloaded files (currently fully supported only `mp3` but you can try whatever you want from [ffmpeg](https://ffmpeg.org/ffmpeg-formats.html#Muxers)) |
PORT | 3000 | Port of Spooty server |