Skip to content
Basenet
🇳🇱 Nederlands
Esc
↑↓navigate↵open⌘Jpreview

Setup and checks

Local boot, operational scripts, and runbooks that matter day to day.

Canonical detail lives in the repo runbooks (docs/runbooks/local-dev.md); this page keeps the essentials.

Local setup

git submodule update --init
corepack enable && pnpm install
pnpm dev

pnpm dev boots Docker Compose services, provisions the demo tenant, and starts web (:3000), portal (:3001), and workers.

Partner + developer docs (this site):

pnpm --filter @blinqx/docs dev
# http://localhost:4322

Operational entrypoints

Script / entry Purpose
apps/control-plane CLI Tenant provision, fleet migrations
scripts/dev.mjs Dev orchestration
scripts/check-openapi.mjs Live OpenAPI smoke
scripts/validate-residency.mjs EU residency gate
scripts/conformance.sh Conformance suite
pnpm docs:openwiki Safe OpenWiki refresh (do not run bare openwiki --update)

Runbooks

Under docs/runbooks/: deploy, cutover, incident, restore, tenant provisioning, M365/WOPI, and docs surfaces:

Checks when changing ops code

  • Provisioning / fleet → control-plane CLI + related runbooks
  • Startup → pnpm dev still boots documented services
  • Docs site → pnpm --filter @blinqx/docs build and symlink checks in docs-surfaces.md

Was this page helpful?