README.md

WebDemos

Status: Experimental, still in development.

WebDemos is a free and open-source application to help you provide SourceTV / GOTV demos from your game servers to players.

Feature Roadmap / TODO

• Frontend to Browse Demos
• Automatic demo deletion
• Seperate demos by server
• Demo compression
• User login / Require auth to download/view demos
• Backblaze B2 support

Includes API Server utilities:

• morgan
  • HTTP request logger middleware for node.js
• helmet
  • Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
• dotenv
  • Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env

Development utilities:

• nodemon
  • nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.
• eslint
  • ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• mocha
  • ☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️
• supertest
  • HTTP assertions made easy via superagent.

Setup

npm install

Lint

npm run lint

Test

npm run test

Development

npm run dev

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT