Modules¶
Feature-level documentation for each platform module. Each module follows the same pattern: entity definitions, API endpoints, frontend routes, configuration options, and known limitations.
V1 Modules¶
| Module | Purpose | Status |
|---|---|---|
| Projects & Sites | Core hierarchy: projects contain sites | V1 |
| Site Diary | Daily site activity log | V1 |
| Personnel & Attendance | Worker register, sign-in/out, induction tracking | V1 |
| Plant & Equipment | Asset register, hire tracking, inspections | V1 |
| Documents | File register with version control | V1 |
| Incidents | Near miss and incident reporting | V1 |
| Inductions | Site induction templates and sign-off | V1 |
| Deliveries | Materials delivery log | V1 |
| Subcontractors | Subcontractor company management | V1 |
V2 Modules (planned)¶
- Timesheets
- RAMS (Risk Assessments)
- Snag Lists / Inspections
- Reporting & Dashboards
- AI Smart Import
- AI Licence Scanning
How module docs are structured¶
Each module page contains:
- Purpose — what the module is for, who uses it
- Entities — the data model (tables, columns, relationships)
- API endpoints — REST endpoints with examples
- Frontend routes — URL paths and key components
- Configurable fields — which fields are extensible per tenant
- Permissions — which roles can do what
- Offline behaviour — what syncs, what doesn't
- Common issues — known limitations and gotchas