Developer docs. You want to read, run, deploy or change the code. Not what you came for? Find the right docs.
These pages are generated from the Markdown in the repository’s docs/ folder and from the code, so they stay in step with it. The specifications behind them are the PRD and the SRS.
- ArchitectureHow the Worker, the ChannelRoom Durable Object, D1, R2, the Queue and Twitch fit together.Read the page
- Run it locallyTry the demo, run the app on your machine and register a Twitch application.Read the page
- Project structureThe repository layout, folder by folder.Read the page
- API and WebSocket contractsThe schemas for network responses and overlay messages, read from the code.Read the page
- DeploymentShip the Worker and the website, and read the workflows.Read the page
- Testing and CIRun the suites and understand the CI gates.Read the page
- Design system and tokensThe tokens, the contrast gate and the brand kit.Read the page
- ContributingMake a change the way this repository expects.Read the page
- How it was built with CodexThe process this project was built with.Read the page
Source code: https://github.com/harshbhx/modscrim (MIT licence).