@voxgig/build

Code generation for Voxgig system projects. Reads the compiled voxgig-model (model.json) and generates deployment artifacts and application code with the jostraca templating library:

• EnvLambda — AWS Lambda deployment templates (Serverless function defs, per-service handlers, resources).
• EnvGen — per-environment deployment artifacts (local, basic, docker, vm, aws, azure, cloudflare, web) driven by the model's main: env: declarations.
• EnvWeb — a full model-driven enterprise web app: SPA frontend (public site, login, app shell, generic entity CRUD with relationship navigation, settings), backend web runner, auth + generic entity services, design themes, customisation hooks, and custom entity views.
• Docs — model-driven documentation for generated projects: mermaid ER / message-flow / system-map diagrams and per-service READMEs, regenerated on every model-build.
• Api — a strict-JSON REST API defined by the model (main.api): uniform entity paths, API-key auth, an OpenAPI spec generated from the entity field definitions, and generated request-validation shapes.

Generation is normally driven by npm run model-build inside a project created with npm create @voxgig/system — you rarely call this package directly.

Documentation

Organised by the Diátaxis framework:

• Tutorial: From model to generated app
• How-to guides:
  • Customise generation templates
  • Generate the web app (EnvWeb)
  • Add a target environment
• Reference:
  • Public API
  • EnvWeb: files, slots, model inputs
• Explanation: Design

Working on this repo with an AI agent? See AGENTS.md.

Develop

npm install
npm run build   # tsc -> dist/ (dist is committed; always rebuild before commit)
npm test        # node:test + coverage thresholds

License

MIT. Copyright (c) Voxgig Ltd.