Aultrum Canvas

Canvas runs Aultrum's modules, Gateway (one conversation layer for every channel, agent and person) and Peak (recognition and rewards), and streams them into the platforms customers already use, starting with Pleasant.

• App and sign-in: canvas.aultrum.co.uk
• Marketing: aultrum.co.uk/canvas
• Aultrum ID and Aultrum Workspace live in their own repository, Addyx2/aultrum-id.
• Contract between Canvas, modules and platforms: docs/MODULE_CONTRACT.md

What's here

Area	Path
Console: overview, Elements, connected systems, installations, events, developer guide	app/(console)
Platform API: modules, installations, events, embed tokens	app/api/v1
Module screens embedded in platforms	app/embed/[module]
Module manifests	lib/modules.ts
Embed tokens, webhook signatures, platform credentials	lib/embed-token.ts, lib/webhook-signature.ts, lib/credentials.ts

Run locally

cp .env.example .env        # set DATABASE_URL and AUTH_SECRET
npm install
npm run db:deploy
npm run db:seed             # [email protected] / canvas-demo-123
npm run dev -- -p 3200

npm run check runs typecheck, lint and tests.

Deploy (Vercel)

1. Import this repository as a new Vercel project.
2. Storage → create a Postgres database for it. That sets DATABASE_URL, the only setting it needs: the signing secret is made on first start and kept in the database, and the address defaults to https://canvas.aultrum.co.uk.
3. Add the domain canvas.aultrum.co.uk to the project, and the CNAME record Vercel shows to your DNS.
4. Open the site and create your organisation. Sign-up stays open to anyone (set ALLOW_SIGNUP=false to make it invite-only).

Changing the database

Deploys run scripts/db-deploy.mjs: it applies the migrations in prisma/migrations, then checks the live database matches prisma/schema.prisma and stops the deploy if it doesn't. A database from before migrations is marked as at 0_baseline once.

To change the schema: edit prisma/schema.prisma, run npm run db:migrate -- --name what_changed (creates the migration and applies it locally), and commit both. CI fails if the schema changes without a migration, or if a migration drops or rewrites data without a -- destructive: reviewed line in it.