Docs

Quickstart

Run a first Codebase build from the web workspace and keep the result editable.

Create a build

Open /workspace.
- Local checkout note: run cd web && npm run dev:all and keep NEXT_PUBLIC_CONVEX_URL set in web/.env.local. If that env var is missing, the workspace now shows a local-setup prompt instead of crashing.
Describe the app in plain language.
Keep the first request narrow: audience, core pages, data shape, and any integration you already know you need.
Review the live preview while the build runs.
Continue with follow-up requests once the first result is previewable.

Keep prompts concrete

Specific product detail works better than broad taste language. For example, ask for "a booking page for a barbershop with services, prices, staff bios, and a contact form" before asking for visual polish.

Understand build limits

Production builds run through a bounded queue. Build limits documents current concurrency, queue, timeout, ownership, and deploy expectations.

Next steps

Use /docs/api when you want to automate builds or deploys outside the browser. Use /docs/deploy-secrets before a generated app needs provider keys or production environment variables.