Skip to content

Development

Run and check the prototype locally.

TL;DR — ASD-STE100 style

  • Use pnpm and a local MongoDB instance.
  • Run the checks that match your change.
  • Read the repository instructions before modifying content or data.

Local setup

Install the repository dependencies with pnpm install. Run pnpm db:up to start local MongoDB, then pnpm dev to start Next.js. The Payload admin is at /admin. Local environment configuration must point to local MongoDB.

Checks

Run pnpm lint after changes. Use pnpm typecheck and pnpm test when applicable. Copy or fixture changes also require pnpm claims:scan and pnpm i18n:audit. See repository instructions and the README for full commands and prerequisites.

Documentation site

From docs-site, run pnpm install, pnpm dev, and pnpm build. Set DOCS_SITE_URL to the approved public origin before publishing; the default is for local use.

Type to search…

↑↓ navigate↵ selectEsc close