/ Development View source
Projects/ImmuKnow/Projects and Contracts
Development documentation from main. Features may not be released. Read the current release.

ImmuKnow projects and contracts

Project Description
ImmuKnow Native CSV preparation, validation, Typst compilation, PDF encryption, bundling and reporting. Supplies the shared Typst library and JSON schemas.
Template Starter notices, wording, translations, settings, branding, project configuration and reference lists.
Studio Browser editing, previews, local drafts and project import/export.

Your organization adapts an authored notice project from Template. Keep ImmuKnow's shared library intact in templates/lib/immuknow/. ImmuKnow reads the project, CSV and explicit notice choices to produce PDFs, bundles and reports. The source system assesses immunization status; operators review notices before delivery.

See the getting started guide for native notice generation, Template's setup instructions for a starter project, and Studio's documentation for browser editing and project export. Each project owns its setup, compatibility and maintenance instructions.

Native handoff

ImmuKnow exports its schemas and complete Typst library for projects and authoring tools. Template supplies authored notices and configuration; Studio consumes ImmuKnow's contracts for previews and exported projects.

The command and facts reference owns export commands, resource identity, schema versions and the preparation envelope. The template guide owns the authoring contract.

Testing the handoffs

Each project tests its own behavior and the files it hands to its consumers. ImmuKnow's testing guide defines these boundaries and the checks needed for resource and pin updates. See Template's contributor guide and Studio's development guide for their execution instructions.