Reggie Documentation¶
UK number plate valuation platform -- Next.js 15 + FastAPI + PostgreSQL + Clerk Auth + SST (AWS).
Getting Started¶
| Doc | Description |
|---|---|
| Quickstart | Clone to running in 5 minutes |
| Your First Endpoint | Tutorial: add a feature end-to-end |
How-To Guides¶
| Doc | Description |
|---|---|
| Add an API Endpoint | Backend route + schema + service + tests |
| Create a Migration | Database migration workflow and pitfalls |
| Deploy | Deploy to staging or production via SST |
| Type Generation | Sync TypeScript types from backend OpenAPI |
Reference¶
| Doc | Description |
|---|---|
| Architecture | System architecture, auth model, valuation overview |
| Environment Variables | All env vars across all services |
| CI/CD | GitHub Actions workflows, triggers, secrets |
Decisions (ADRs)¶
| Doc | Description |
|---|---|
| ADR Index | Architecture Decision Records index + template |
| 001: Clerk Auth | Why Clerk over Supabase Auth |
| 002: LightGBM | Why LightGBM for ML valuation |
| 003: SST | Why SST for AWS infrastructure |
Infrastructure¶
| Doc | Description |
|---|---|
| SST Resources | Resource map, Mermaid diagrams, secrets, costs, domains |
| AWS OIDC Setup | GitHub Actions OIDC for AWS deployment |
| Deployment Runbook | Deploy, migrate, rollback, monitor, backup/recovery |
Features¶
| Doc | Description |
|---|---|
| Valuation | ML + rules ensemble system deep-dive |
| Security | Auth model, JWT flow, storage security |
Troubleshooting¶
| Doc | Description |
|---|---|
| Solutions Index | Documented solutions for complex problems |
Historical¶
These documents reflect earlier project states and are preserved for context:
| Doc | Notes |
|---|---|
| V1 Specification | Original product spec (references Supabase Auth -- see ADR-001 for current auth) |
| Market Research | UK plate transfer regulatory research (October 2025) |