FFF Engineering Docs
Internal documentation for every project in the Funded Futures Family engineering ecosystem — architecture, modules, page-by-page UI catalogs, and the request flows that connect them.
This site is organized one section per project. Start with whichever project you're touching; the System architecture section covers how the projects fit together.
Documented so far
| Project | What it is | Status |
|---|---|---|
| fff-risk-web | Next.js staff dashboard for risk, payouts, and compliance | ✅ Documented |
| Internal user features | Admin console + trader dashboard SOPs (FFF-Frontend) | ✅ Documented |
| fff-risk-api | Django views/RBAC layer for the risk dashboard | 📋 Referenced in System architecture only — full module docs pending |
| FFF-Backend | Core trading-platform backend (users, accounts, payouts, security-flag engine) | 📋 Referenced in System architecture only — full module docs pending |
| fff_be_automation | Celery worker executing async jobs dispatched by the other backends | ⏳ Not yet explored |
See Ecosystem projects for the full list of repositories under ~/Work/fff, including ones with no documentation here yet.
How this site is organized
Each documented project gets its own top-level sidebar section, generally shaped like:
- Overview — what the project is, its architecture at a glance
- Architecture — one page per module/subsystem (API layer, auth, state management, UI, etc.)
- User flow — the request/session flows that tie modules together, as diagrams
- Internal user features (FFF-Frontend) — SOPs for every admin sidebar item and trader dashboard / affiliate screen
- Pages & Actions (other frontend projects) — every route, its sub-components, and every button/mutation available on it
Contributing to these docs
This site lives at ~/Work/fff/fff-docs, a sibling to the project repos it documents (~/Work/fff/risk-dash, ~/Work/fff/new-dash, etc.) rather than inside any one of them, since it spans multiple repositories.
cd ~/Work/fff/fff-docs
pnpm start # local dev server with hot reload
pnpm build # production build — run this before committing doc changes