Developer Documentation
Technical documentation for developers contributing to or extending the Forge platform.
For deployment, operations, and feature guides, see the User & Admin Docs.
Architecture
| Document | Description |
|---|
| Backend (Django) | App structure, models, API views, serializers, signals, management commands |
| Frontend (React) | React 18 SPA, TypeScript, Vite, TanStack Query, Zustand, routing, components |
| Task Engine | Job lifecycle, dispatcher, callback receiver, Receptor mesh, capacity |
| Authentication & RBAC | Auth methods (session, OAuth2, LDAP, SAML), role hierarchy, permissions |
Reference
| Document | Description |
|---|
| Database Schema | ER diagram, all table descriptions, diagnostic queries, PostgreSQL tuning |
| API Reference | Complete REST API endpoint reference for every resource |
| Configuration | All env vars, Django settings, database-backed settings, performance tuning |
Workflow
| Document | Description |
|---|
| Testing Guide | Test suite layout, running unit/functional tests, coverage, standalone tests |
| CI/CD Pipeline | GitHub Actions stages, CalVer versioning, release process |
| Contributing Guide | Git workflow, commit conventions, coding standards, PR checklist |