GETTING_STARTED.md

Getting Started

Owner: Nick Last Verified: 2026-03-05 Status: Active

Requirements

• Node 18.18+
• pnpm 9+

Bootstrap

pnpm bootstrap

Validate baseline

pnpm check:all

Start local app

pnpm dev

First extension step

pnpm scaffold:app --name billing
pnpm check:all

Monorepo workforce start (optional)

pnpm scaffold:workforce --web studio --api core
pnpm install
pnpm --dir apps/studio dev

Alternative starts:

# Next.js only
pnpm scaffold:next-app --web studio

# FastAPI only
pnpm scaffold:fastapi-service --api core

Troubleshooting

• If verify:ui fails, inspect artifacts/ui-evidence.json.
• If verify:obs fails, inspect artifacts/obs-evidence.json.
• If docs lint fails, make sure metadata fields and index links are present.
• In constrained environments where local ports are blocked, run with VERIFY_ALLOW_OFFLINE=1 pnpm check:all.