🌐 Language: English · Tiếng Việt · 中文 · 한국어
Production-grade monorepo scaffold for shipping Flutter + NestJS + Postgres applications.
- Getting Started — prerequisites, clone, configure, run (15 min)
- Overview — what this is, who it's for, out-of-scope decisions
- Architecture — data flow, layers, OpenAPI codegen pipeline
- Backend Module — NestJS controller + service + DTO with auth/envelope rules
- Prisma Module — extend database schema + wire into service layer
- Flutter Feature — directory layout, repository pattern, Riverpod, routing, tests
- API Contract — regenerate Dart client + sync tests when an API changes
| Doc | Purpose |
|---|---|
| Codebase Map | File tree + quick-reference ("where do I add a new X?") |
| Code Standards | Naming, file size, TS/Dart style, test structure, commit format |
| Feature Boundaries | Module isolation rules (no cross-imports) |
| Dependency Injection | NestJS providers/scopes, Riverpod overrides, worked examples |
| Design Guidelines | Material 3 theme, typography, spacing, reusable widgets |
| i18n Guide | ARB workflow, translation keys, pluralization, adding locales |
| Deployment | Docker backend, app signing, semantic-release flow |
| Changelog | Release notes (Keep a Changelog, auto-updated by semantic-release) |
docs/
├── README.md ← this file
├── overview.md
├── architecture.md
├── codebase-map.md
├── code-standards.md
├── design-guidelines.md
├── feature-boundaries.md
├── dependency-injection.md
├── i18n-guide.md
├── deployment.md
├── guides/
│ ├── getting-started.md
│ ├── backend-module.md
│ ├── prisma-module.md
│ ├── flutter-feature.md
│ └── api-contract.md
└── languages/
├── vi/ ← Vietnamese mirrors
├── zh/ ← Simplified Chinese mirrors
└── ko/ ← Korean mirrors
The project changelog lives at /CHANGELOG.md (root, with translations under docs/languages/{lang}/CHANGELOG.md).
| Role | Read order |
|---|---|
| Backend Dev | code-standards → backend-module → feature-boundaries |
| Mobile Dev | getting-started → flutter-feature → i18n-guide |
| DevOps / Infra | deployment → architecture |
| New Contributor | overview → getting-started → codebase-map |