Quickstart - Insight Flow

Requirements

Python 3.12+
Node.js 18+
Docker / Docker Compose

First-time Setup

From the repository root:

cp .env.example .env
make bootstrap
make doctor

Notes:

make bootstrap installs and repairs local dependencies
make doctor checks Python, Node, Docker, and service prerequisites

Daily Development Startup

make dev-local

If you prefer to start services separately:

make infra-up
make migrate
make backend
make frontend

Endpoints

Frontend: http://localhost:3018
Backend OpenAPI: http://localhost:8000/docs
Health check: http://localhost:8000/health
Mint docs preview: run mint dev inside docs/

First Working Flow

Open the frontend and go to Providers
Configure llm_openai or llm_codex
Enable at least one destination
Review preset sources or add your own source
Create a daily monitor
Run it and inspect runs, reports, and destination output

Useful Commands

make sync-sources
make test-all
make infra-down
make backend-browser-deps

Troubleshooting

OpenAPI docs are not available

Make sure the backend is running, then open http://localhost:8000/docs.

The Mint docs site will not start

Inside docs/, run:

mint validate
mint dev