Docs AtlasDocs

Get started

Quickstart

Run it on your machine and check a change.

  1. Install the dependencies.

    Terminal
    npm install
  2. Create the local database. It applies every migration to a local copy of D1.

    Terminal
    npm run db:migrate:local
  3. Add local secrets. Create .dev.vars next to package.json.

    .dev.vars
    EDIT_PASSCODE=choose-a-long-passcode
  4. Start the app and open http://localhost:3000.

    Terminal
    npm run dev

Checks before a change

Terminal
npm run typecheck
npm run lint
npm run build

Run and validate

Terminal
npm install
npm run db:migrate:local
npm run dev
npm run cf-typegen
npm run typecheck
npm run lint
npm run build
npx opennextjs-cloudflare build
npx wrangler deploy --dry-run --env=""

Only the production D1 binding, docs-catalog-db, is part of the Worker configuration. Apply its remote migrations before deploying production. The removed development Worker environment is intentionally not deployable from this repository. The public custom domain is docs.appneural.com.

The committed production database ID is the deployment source of truth. The corresponding subdomain-catalog entry must remain Reference and unverified until the production hostname is live-verified.

Last updated 2 November 2026