15 lines
927 B
Markdown
15 lines
927 B
Markdown
|
|
# RE:Quest — system documentation
|
||
|
|
|
||
|
|
| Document | Contents |
|
||
|
|
|---|---|
|
||
|
|
| [architecture.md](./architecture.md) | Components, runtime topology, auth model, roles, configuration contract, DB change process |
|
||
|
|
| [data-model.md](./data-model.md) | ER diagram + every entity, field and enum (generated from `prisma/schema.prisma`) |
|
||
|
|
| [flows.md](./flows.md) | Sequence diagrams: registration, login & 2FA, Google sign-in, connection requests, real-time messaging, subscription/payment & Stripe webhooks, agent verification, file upload; email trigger events; data-flow diagram |
|
||
|
|
| [2fa-key-rotation.md](./2fa-key-rotation.md) | How to rotate `JWT_SECRET` without locking out every 2FA user |
|
||
|
|
|
||
|
|
Diagrams are Mermaid embedded in Markdown: source-controllable, diffable, and
|
||
|
|
rendered natively by GitHub/GitLab.
|
||
|
|
|
||
|
|
`data-model.md` is generated from the Prisma schema — regenerate it after any
|
||
|
|
schema change rather than editing it by hand.
|