Skip to main content

Quickstart

Quickstart — Run the platform locally​

Follow these steps to run the application and the docs site locally.

1) Install dependencies​

npm ci
npm --prefix docusaurus-docs ci

2) Run the application (dev)​

Open a terminal and run:

npm run dev

This prepares the workspace package exports, generates the domain composition, and starts the local Mastra runtime. The runtime target defaults according to the local launcher configuration.

To select a domain explicitly, use one of:

npm run dev:k12
npm run dev:sdac
npm run dev:tap
npm run dev:handbook

For the broader local stack, including supporting application surfaces, use npm run stack, stack:k12, stack:sdac, stack:tap, or stack:handbook. The matching *:stop commands stop those stacks.

3) Start the docs site​

In a separate terminal:

npm --prefix docusaurus-docs run start:internal

The internal docs site will be available at http://localhost:3001.

4) Compose and validate environment variables​

npm run env:compose
npm run check:env

The composer builds the local environment from the checked-in configuration surfaces without making a cloud deployment. Review environment variables, deployment, and the repository README.md before connecting to hosted resources.

5) Helpful commands​

  • npm run build — build the composed Mastra runtime
  • npm run build:k12, build:sdac, build:tap, build:handbook — build a domain-targeted runtime
  • npm run test:contracts — verify generated runtime/API contracts
  • npm run test:k12, test:sdac, test:tap, test:handbook — run the owning domain suites
  • npm run test:infra — validate deployment and infrastructure contracts
  • npm run contracts:check — check generated runtime and widget API artifacts

Use Testing for the current suite map and Bruno Testing for HTTP contract coverage. Live tests and any operation that targets Azure require the documented environment and write gates; ordinary local startup does not authorize a deployment.