Skip to Content
Getting StartedQuick Start

Quick Start

Prerequisites

Clone and install

git clone <repo-url> && cd aura-symphony npm install

Create your environment file

cp .env.example .env

Add your Gemini API key

.env
GEMINI_API_KEY=AIzaSy...your_actual_key

Start the dev server

npm run dev

The app runs at http://localhost:3000.

You can also configure providers entirely in-app — including OpenAI-compatible endpoints, Ollama, and local LLMs — via the Settings panel. See Configuration.

Optional: start the backend stack

All backend services are optional — the frontend degrades gracefully to browser-local alternatives. To run the full polyglot stack:

docker compose up
ServicePort
API Proxy3005
Vector Search (ChromaDB)3001
Media Pipeline (FFmpeg)3002 / 3003 (WebSocket)
Graph Knowledge (SQLite)3004
CLIP Embeddings3006

Useful scripts

CommandWhat it does
npm run devStart the Vite dev server
npm run buildProduction build (~29s)
npm run previewPreview the production build
npm run lintTypeScript type check (tsc --noEmit)
npm testRun the unit test suite (Vitest)