Dev Manual
Developer reference for the onyx codebase — architecture, database, deployment, features, API, integrations.
The Dev Manual is for engineers working on the onyx codebase. It covers everything you need to navigate the system as a contributor:
- Getting started — clone, env, dependency setup (incl. Windows).
- Architecture — how the Flask app, the two portals, and the rate-card / transit-time subsystems fit together.
- Database — schema, SQLAlchemy patterns, migration workflow.
- Deployment — Railway services, Docker, env vars, checklists.
- Features — implementation notes for the major subsystems (Create Booking, Quotation, Addons, Transit Times, …).
- API — REST surface exposed by the app.
- Integrations — external systems (iDrv4 / Ceres TMS).
- Meta — the help system itself + AI prompt library.
End-user docs live in the Admin Guide and Customer Guide — those are surfaced inside the portal via the ? help drawer.