Documentation menu

Get Started

Run Locally

Run the API and dashboard from source with npm — the best setup for active development and writing scenarios.

Prerequisites

  • Node.js ≥ 20 and npm.
  • A PostgreSQL database and a Redis instance reachable from your machine (e.g. docker run -p 5432:5432 -e POSTGRES_PASSWORD=aria postgres:16-alpine). The one-command Docker stack keeps its Postgres/Redis internal to the compose network, so for npm run dev you provide your own host-reachable instances.
  • AWS credentials with Bedrock access for the judge.

1. Install dependencies

npm install

2. Configure the environment

Copy the example env file and fill in the essentials:

cp .env.example .env

At minimum, set:

  • DATABASE_URL — your Postgres connection string, e.g. postgresql://aria:aria@localhost:5432/aria?schema=public
  • REDIS_HOST / REDIS_PORT — defaults localhost / 6379
  • JUDGE_BEDROCK_REGION and your AWS credentials (for the judge)
  • ACCESS_TOKEN_SECRET / REFRESH_TOKEN_SECRET — any strong random strings

The full list is in Configuration.

3. Set up the database

npm run db:generate   # generate the Prisma client
npm run db:migrate    # apply the schema to your database

4. Start the dev server

npm run dev

This runs the API (tsx watch src/api/server.ts) and, once it’s healthy, the Vite UI — both served at http://localhost:3001. Edits hot-reload. From there you can launch runs in the dashboard or use the CLI.

Other useful commands

CommandDescription
npm run lintType-check the project (tsc --noEmit)
npm run buildBuild the API + UI for production
npm run db:studioOpen Prisma Studio to browse the database
npm run db:pushPush schema changes without a migration (prototyping)