diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c30d4a..73d08a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ ### Changelog -All notable changes to this project will be documented in this file. Dates are displayed in UTC. \ No newline at end of file +All notable changes to this project will be documented in this file. Dates are displayed in UTC. + +### 1.0.0 +- initial release \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index 13bae56..2781fb7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Filip Gulan +Copyright (c) 2024 Filip Gulan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/source.md b/docs/source.md index dbb2cca..790480c 100644 --- a/docs/source.md +++ b/docs/source.md @@ -1,3 +1,25 @@ # Build from source -TODO \ No newline at end of file +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 | \ No newline at end of file