This repository has been archived on 2021-01-16. You can view files and clone it, but cannot push or open issues/pull-requests.
2019-09-24 18:42:13 -05:00
|
|
|
## Satyr: A livestreaming server
|
2019-09-24 18:35:11 -05:00
|
|
|
|
|
|
|
|
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
|
|
|
|
|
|
2020-07-04 10:06:52 -05:00
|
|
|
### Build Instructions
|
2019-09-24 18:35:11 -05:00
|
|
|
```bash
|
|
|
|
|
git clone https://gitlab.com/knotteye/satyr.git
|
|
|
|
|
cd satyr
|
|
|
|
|
npm install
|
2019-10-05 15:11:03 -05:00
|
|
|
npm run setup
|
2020-07-04 10:06:52 -05:00
|
|
|
npm run build
|
2019-09-24 18:35:11 -05:00
|
|
|
```
|
2019-10-20 16:30:23 -05:00
|
|
|
Follow the instructions after setup runs.
|
2019-09-24 18:35:11 -05:00
|
|
|
|
2019-09-24 18:42:13 -05:00
|
|
|
### Run the server
|
2019-09-24 18:35:11 -05:00
|
|
|
```bash
|
|
|
|
|
npm start
|
2019-09-24 18:42:13 -05:00
|
|
|
```
|
2020-07-04 10:06:52 -05:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
1. Fork the repository
|
|
|
|
|
2. Create new feature branch
|
|
|
|
|
3. Write Code
|
|
|
|
|
4. Create an request to merge back into develop
|
