This folder contains the shared project documentation for both services in this repository:
client/(Next.js app)server/(Express OAuth service)
Use this as the source of truth for onboarding, architecture, and engineering practices.
- Product and operations stakeholders who need feature-level understanding
- Engineers onboarding to the codebase
- Engineers implementing or reviewing changes
- QUICKSTART.md
- PRODUCT_GUIDE.md
- ARCHITECTURE.md
- TECHNICAL_REFERENCE.md
- ENGINEERING_PRACTICES.md
- TROUBLESHOOTING.md
| Document | Purpose |
|---|---|
| QUICKSTART.md | Run the project locally in a predictable way |
| PRODUCT_GUIDE.md | Understand what the product does and who it serves |
| ARCHITECTURE.md | Understand runtime architecture and data flows |
| TECHNICAL_REFERENCE.md | Code-level map of modules, APIs, and types |
| ENGINEERING_PRACTICES.md | Team conventions for quality, reviews, and changes |
| TROUBLESHOOTING.md | Known issues, root causes, and recovery steps |
These docs describe the current implementation in this repository. If behavior changes, update documentation in the same pull request as the code change.
- Primary owners: contributors to this repository
- Update trigger: any change to auth flow, API contracts, or core user workflows