knotteye
9e5b3f360c
Client templates -> develop See merge request knotteye/satyr!27 |
||
---|---|---|
config | ||
docs | ||
install | ||
site | ||
src | ||
templates | ||
.gitignore | ||
CONTRIBUTORS | ||
LICENSE | ||
README.md | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
README.md
Satyr: A livestreaming server
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
Setup Instructions
git clone https://gitlab.com/knotteye/satyr.git
cd satyr
npm install
npm run setup
Follow the instructions after setup runs.
Run the server
npm run start
You can also skip checking the database version and compiling templates (if you don't use server-side rendering) on startup.
npm run start -- --skip-migrate --skip-compile
# don't forget to migrate manually when you update
npm run migrate
# and compile templates after any changes
npm run make-templates
Contributing
- Fork the repository
- Create new feature branch
- Write Code
- Create an request to merge back into develop