Quick Start

This gets you a running dashboard with live data in about five minutes, using the built-in simulator — no inverter required. It uses bun as the runtime and package manager.

No hardware needed

INVERTER_SIMULATE defaults to true, so SunReye runs against a coherent fake inverter out of the box. Point it at real hardware later from the Settings screen.

Prerequisites

• bun installed
• Docker (for the TimescaleDB database)

See Requirements for details.

1. Install dependencies

bun install

2. Start the database

This runs a TimescaleDB container via Docker Compose:

bun run db:start

3. Create the schema and TimescaleDB objects

bun run db:push
bun run db:timescale

db:push applies the Drizzle schema; db:timescale creates the hypertable and the continuous-aggregate rollups.

4. Start everything

bun run dev

This starts the core engine, the web dashboard, and tails the database — all together.

5. Open the dashboard

• Dashboard: http://localhost:5173
• API + OpenAPI docs: http://localhost:3000 — Scalar UI at /openapi

On first run you’ll be taken through onboarding to create the initial admin account. After that, the dashboard renders live simulated data.

What next?

• Point it at a real inverter from the Settings screen.
• Deploy with Docker Compose for a persistent install.
• Explore the REST API or set up the MQTT bridge.
• Author a profile for an unsupported inverter.