Documentation

Documentation / Quickstart

10-minute quickstart

This flow creates your first run end-to-end: engine, dashboard, and SDK ingest.

1) Start engine

$ cd guardonic-engine
$ cp .env.example .env
$ npm install
$ npm run start:dev

2) Start dashboard

$ cd guardonic-dashboard
$ cp .env.example .env
$ npm install
$ npm run dev

3) Send first telemetry run

$ cd guardonic-node
$ npm install
$ npm run demo

4) Verify in dashboard

  • Open `http://localhost:3001`.
  • Open your latest run row and confirm timeline events render.
  • Check contract version `2026-04-15.v1` in API responses.

Expected activation time

Most developers should reach first signal in 6-10 minutes on a fresh machine with Node 18+ and Mongo running.