Repository navigation
Development
Node from .nvmrc (24 or later), pnpm from packageManager in package.json.
pnpm install
pnpm verify # Biome, the version check, types, tests and the build: run before calling work done
pnpm check # Biome only; `pnpm fix` writes its fixes
pnpm --filter @spotcraft/dashboard testDon't leave pnpm dev servers running in a shared checkout: they hold ports 3000 and 5173.
| Path | What |
|---|---|
agent |
the agent (Fastify): deploys the apps |
mail |
the mail relay apps send through (SMTP) |
apps/dashboard |
the dashboard (SvelteKit) |
packages/cli |
spotcraft dev per repo, app schema provisioning |
packages/ui |
shared components and theme (shadcn-svelte) |
infra/server |
compose file, Caddyfile and monitoring config |
infra/remote-deploy.sh |
what a deploy runs on the server (in the bundle) |
docs |
this wiki: guides, development, decisions |
Every package and infra/* folder has a README that says how it works now.
Spotcraft has one version, following Semantic Versioning. The image
vindotski/spotcraft is tagged X.Y.Z and X.Y, and the CLI on npm (@kodentuzo/spotcraft)
carries the same version. What counts as a breaking change is defined in
ADR 0019. Releasing has the steps.
Branches, commits and pull requests follow the ecosystem's
AGENTS.md and
CONTRIBUTING.md. Docs move with the code: a package's README and the
Unreleased section of the changelog change in the same commit. A decision gets
an ADR in decisions.
Published from docs/. Edit the files there; changes here are overwritten.