Developers
TrainUs technical documentation: architecture, database layer, and guides for contributing to the project.
Getting Started
Set up your dev environment, run TrainUs locally, and make your first change.
- What You’ll Need
- Clone and Install
- Run the App
- A Quick Tour of
src/ - Run the Test Suite
- Make a Small Change
- Going Further
How-to Guides
Step-by-step recipes for common contributor tasks: languages, themes, deployment, migrations.
Read moreReference
Architecture, database schema, features, routing, i18n, versioning, and build commands — the full technical reference.
- 1. Architecture
- 2. Database Layer
- 3. Features
- 4. Routing
- 5. Internationalization
- 6. Versioning
- 7. Build Commands
- 8. Annexes
Understanding the Architecture
The why behind TrainUs's technical choices: local-first, the Worker thread, the migration system, and a few notable feature decisions.
- Why No Backend?
- Why SQLite Runs in a Web Worker
- Why the
opfs-sahpoolVFS — and No Fallback - Why the Migration System Is Built This Way
- A Few Notable Feature Design Decisions
- Why the Content Width Cap Is Deliberate