Repository navigation
Getting Started
github-actions[bot] edited this page Nov 20, 2026
·
2 revisions
-
Node 26 (the version is in
.nvmrc) -
pnpm 12 (
corepack enablepicks up the version inpackage.json) - Docker, for Spotcraft's local stack: Postgres, the user pool and Mailpit
pnpm install
pnpm exec spotcraft dev
pnpm dev-
pnpm installalso runsnuxt prepare. -
pnpm exec spotcraft dev(from@kodentuzo/spotcraft) starts a stack for this checkout that's set up like a Spotcraft server: Postgres with theapp_sokobankoschema, the user pool, and Mailpit. It writes the settings to.envat the repository root, then runspnpm db:migrate(fromspotcraft.json), which applies the migrations and with them the levels. -
pnpm devserves the app at http://localhost:3000.
Solve the first level, and the browser makes you a guest in the local user pool. Your best then shows on the map and in Progress.
| Command | Does |
|---|---|
pnpm exec spotcraft dev |
Starts the stack if needed, sets up the schema, adds missing settings to .env, and migrates |
pnpm exec spotcraft dev status |
Whether the stack runs, its addresses, and the schema |
pnpm exec spotcraft dev db reset |
Empties the schema and migrates again |
pnpm exec spotcraft dev stop |
Stops the stack; its data stays |
pnpm exec spotcraft dev ls |
Every stack on this machine |
Each checkout (or git worktree) gets its own stack on free ports, so several can run side by side.
The local user pool listens on 127.0.0.1 only. The dev server passes /_spotcraft/auth on to it (nitro.devProxy in nuxt.config.ts), as Spotcraft's proxy does in production. Phones on the same Wi-Fi can play and save:
pnpm dev --host 0.0.0.0Then open http://<your computer's LAN address>:3000 on the phone.
- Development: scripts, tests, migrations and adding levels
- Architecture: how the pieces fit