knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity
A self hosted livestreaming server.
This repository has been archived on 2021-01-16. You can view files and clone it, but cannot push or open issues/pull-requests.
140 Commits
2 Branches
11 Tags
2.4 MiB
TypeScript 69.8%
HTML 18.9%
JavaScript 7.8%
Shell 1.9%
CSS 1.1%
Other 0.5%
 
 
 
 
 
 
Go to file
knotteye 988e3473a7 Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 
Add compiled templates file to .gitignore, will work out a system for making sure templates are compiled later.
Fix a couple bugs in the API and templates.

TODO for client-side rendering:
Make sure templates get compiled before running the server.
Add a config option to switch between server-side and client-side rendering
Fancy SPA stuff like intercepting links to render changes without a page-reload
 		2020-10-14 07:44:19 -05:00
config Big Refactor 2019-12-21 08:59:35 -06:00
docs Rework invitation UI a bit, document API changes 2020-10-13 16:16:37 -05:00
install Tweak config changes, add functionality in server.ts 2020-10-12 11:14:59 -05:00
site Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
src Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
templates Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
.gitignore Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
CONTRIBUTORS Add contributors file 2019-11-05 17:22:52 -06:00
LICENSE Add package.json and LICENSE, name the project. 2019-09-15 12:23:09 -05:00
README.md Implement database versioning and migration. It could not possibly be any simpler or easier to break, but it works. And it can be used to automatically migrate to a better system for migration later. 2020-10-10 15:55:32 -05:00
package-lock.json Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
package.json Big commit. Implement handlers for everything that's currently rendered server side in the client-side frontend. 2020-10-14 07:44:19 -05:00
tsconfig.json Changed init functions to be more consistent. 2019-09-26 14:43:24 -05:00

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 run this to skip checking the database version on startup.

npm run start -- --skip-migrate
# don't forget to migrate manually when you update
npm run migrate

Contributing

  1. Fork the repository
  2. Create new feature branch
  3. Write Code
  4. Create an request to merge back into develop