Developer guide
Developer guide
For people who build on IMS Creator: adding a document to the management system, writing a plugin, extending the drawing register, calling the API, or running and testing IMS Creator itself. The user guide explains each screen; this guide explains how they are made.

The pages
| Page | For |
|---|---|
| Architecture | The processes, the packages, how a request, a job and a scheduled task flow, where data lives, single site and multi-company |
| Setting up | A development environment: Python, the front end, the tools the drawing register uses, running the app |
| Documents of the management system | How a document is declared, written by Claude, checked, approved, reviewed and reported; adding one |
| Plugins | The manifest, the Rust SDK, the sandbox, events and schedules, proposals; a plugin from the template to the marketplace |
| The drawing register | The drawreg pipeline: conversion, OCR, title blocks, Claude, EAM matching, the outputs |
| The API | The HTTP API the front end uses, sign-in, and calling it yourself |
| Testing, docs and release | The test suite and its made-up data, the guide's screenshots and generated pages, CI and publishing |
The code at a glance
Principles the code keeps
- Nothing slow in a request. A page queues a job and returns; the worker runs it.
- People decide. Claude drafts; nothing it writes is the record until a person approves it. A plugin proposes; a person accepts.
- Declared, not coded. The documents of clauses 6 to 10 are declared in YAML, plugins in a manifest; the pages, schemas, reports and help pages follow from the declarations.
- No company data in the repository. Tests and the demo use made-up data only.
- The source folder is only ever read. The drawing register never changes, renames or moves a source file.
See also
- The design documents in the repository:
docs/ARCHITECTURE.md,docs/PLUGINS.md,docs/CLOUD-ARCHITECTURE.md,docs/HOSTING.md