Getting Started

Prerequisites

• A working Python environment with project dependencies installed.
• Frontend dependencies installed so you can run npm run build or npm run dev.
• A usable datasource, or the default SQLite setup for local testing.

Boot the project

Local development

python run.py --env dev
cd frontend
npm run dev

In development mode, the frontend is typically served by Vite while the backend provides the API.

Built access

cd frontend
npm run build

cd ..
python run.py --env prod

The build output is written to the project root dist/ folder and then served by Flask.

First login

1. Open the landing page or login page.
2. Sign in with an admin account or an existing test account.
3. Enter the Dashboard page and review the current report list.
4. If this is a fresh environment, create a datasource before building reports.

Create your first report

1. Go to Dashboard and create a new report.
2. Select a datasource and enter a report name.
3. Generate DSDL with AI or write it manually in the Editor.
4. Preview the result and verify the chart or table output.
5. Save and publish, then verify the final result in the View page.

A minimal working example

---
type: metric
title: Total Orders
format: number
---
SELECT COUNT(*) AS value FROM orders

This creates a minimal KPI card. From there you can add inputs, tables, charts, or a larger dashboard layout.

Where to go next