Skip to main content

​
Quickstart

​
Prerequisites

  • Node.js 24+ (check .nvmrc)
  • pnpm 10.32+ (declared in package.json)

​
Clone and install

​
Configure environment variables

Copy the example file and fill in the API keys for the services you want to use:
You don’t need all services configured to start. The dashboard degrades gracefully — widgets that lack credentials simply won’t display data.
See the Services overview for details on where to get each API key.

​
Start the dev server

This runs turbo run dev, which starts the Next.js app at http://localhost:3000 and the default portless route at https://radarboard.localhost:1355. For the dashboard app, the portless route is configured for HTTPS by default:
On the first HTTPS run, portless may prompt you to trust its local development certificate authority.

​
What’s next?

1

Connect services

Head to Services to configure the integrations you care about. Each page tells you exactly where to get the API key and what env vars to set.
2

Explore widgets

Learn what each Widget shows and which services power it.
3

Choose a database

The default is SQLite (zero config). If you want cloud persistence, see Database Providers.