Developer documentation
These pages describe how Spark is built, for engineers who work on it. They are conceptual and generic: they name services and concepts, never hosts, ports, credentials or databases.
Internal APIs
The APIs described here are internal. They are reached only through the Spark backend, which authenticates the user, checks permissions and signs a short-lived service token. They are not a public API and are not reachable from the internet.
Start here
- Architecture: the services and what each one owns.
- Service-to-service auth: how services trust each other.
- Launch data model: criteria, cells, statuses, check methods, readiness.
- Strategy data model: sourced answers, versions, approval and its hash.
- Launch internal API and Strategy internal API: route lists with purpose and permission.
- Shared contracts: the
spark-contractspackage. - Local development & testing: Bun, Vitest, file size and code style rules.
- Release process: the order in which pieces ship.
Status of the work
| Programme step | State |
|---|---|
| 1. Launch readiness (catalogue, checks, identity, documents, i18n, notifications) | Live |
| 2. Strategy workspace (strategy module, self-serve launch setup, monitor) | Rolling out |
| Later steps (more platform services, catalogue sync, campaigns, conversations) | Not started |