Getting started¶
Use this section when you are new to Stat'sTheGame or need to get a local checkout running. The pages here deliberately stay focused on onboarding; deeper architecture, API, testing and deployment material is linked from the relevant section hubs.
First visit¶
Follow this order for the shortest reliable path into the project:
- Read the repository structure to understand the monorepo boundaries.
- Follow Local setup for a clean install and local runtime.
- Use Technology stack when you need to know why a dependency or service was selected.
- Use Environment variables before configuring frontend, backend or worker settings.
- Open the component guide for the part of the system you are changing.
Component guides¶
The component READMEs are the closest guide to each repository area. They remain in the repository rather than being duplicated into MkDocs.
| Component | Guide |
|---|---|
| Frontend | apps/frontend/README.md |
| Backend API | apps/backend/README.md |
| Asynchronous worker | apps/worker/README.md |
| Database | database/README.md |
| Shared contracts | packages/contracts/README.md |
| Documentation | docs/README.md |
| Testing | tests/README.md |
| Infrastructure | infra/README.md |
| Repository scripts | scripts/README.md |
| Project evidence | evidence/README.md |
Where to go next¶
- To use or inspect the public API, continue to Product & API.
- To understand event derivation, persistence and security boundaries, continue to Architecture & Data.
- To contribute code or documentation, continue to Development.
- To understand hosted environments, continue to Deployment & Operations.
- To review quality gates, coverage, performance or user testing, continue to Testing & Quality.
- To inspect Sprint, stakeholder, decision and AI-use evidence, continue to Project Process & Evidence.
AI Declaration¶
The information-architecture and onboarding consolidation on this page was planned and drafted with the assistance of ChatGPT-Web[GPT-5.6 Sol].