​
Prerequisites

  • Node.js 20.17+
  • npm
  • the backend public-api running locally if you want to exercise the playground against a real service

​
Local setup

Run these commands from frontend/docs: 
npm install
npm run sync:openapi
npm run dev
The local preview runs on http://localhost:3006.

​
What the scripts do

  • npm run sync:openapi copies docs/api-spec.openapi.yaml into frontend/docs/openapi/public-api.openapi.yaml
  • npm run dev syncs first and then starts Mintlify preview
  • npm run dev:no-open does the same thing without opening a browser window
  • npm run validate:openapi syncs first and validates the Mintlify docs build, including the mirrored OpenAPI file
  • npm run validate is a short alias for the same Mintlify build validation

​
Local API playground defaults

The starter OpenAPI document includes http://localhost:8082 as the local server URL because that is the checked-in default for public-api. If your public API runs somewhere else, update the servers section in docs/api-spec.openapi.yaml, then sync again.

​
First customizations to make

  1. Replace the project name, colors, and navigation in frontend/docs/docs.json.
  2. Replace the starter prose on the intro and architecture pages.
  3. Expand docs/api-spec.openapi.yaml as your public API grows.
  4. Add more narrative guides before broadening the API surface.