mirror of
https://git.waldn.net/git/knotteye/satyr.git
synced 2025-05-11 05:29:22 +00:00
25 lines
494 B
Markdown
25 lines
494 B
Markdown
## 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
|
|
```bash
|
|
git clone https://gitlab.com/knotteye/satyr.git
|
|
cd satyr
|
|
npm install
|
|
npm run setup
|
|
```
|
|
Follow the instructions after setup runs.
|
|
|
|
### Run the server
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Fork the repository
|
|
2. Create new feature branch
|
|
3. Write Code
|
|
4. Create an request to merge back into develop
|