Quick Start

Get Audra Flow running on your machine in under five minutes. This guide walks you through prerequisites, environment setup, and your first project.

Prerequisites

Before you begin, make sure the following tools are installed on your system:

You will also need API keys for the AI providers used by Audra Flow:

• DeepSeek API key — powers chat and completion features
• OpenAI API key — used for embeddings in the RAG pipeline

Quick Setup with Docker

The fastest way to start is with Docker Compose. Three commands and you're up and running:

# 1. Clone the repository
git clone <repo-url>
cd audra-flow

# 2. Configure your environment
cp env.example .env
# Edit .env and add your API keys:
#   DEEPSEEK_API_KEY=...
#   OPENAI_API_KEY=...
#   JWT_SECRET=<32+ character secret>

# 3. Start every service
make quick-start

That's it. Docker Compose will build and start the web app, AI service, PostgreSQL, and Redis in one step.

Service Access Points

Once the stack is running, the following services are available:

Local Development (Without Docker)

If you prefer to run services natively for faster iteration, follow these steps:

Install Dependencies

make deps

Start the Web Application

npm install
cd apps/web/backend
npx prisma generate
npx prisma migrate dev
cd ../../..
npm run dev

Start the AI Service

cd apps/ai-service
poetry install
poetry run uvicorn src.main:app --reload --port 8000

Your First Project

1. Open the web application at http://localhost:3001.
2. Sign in with the demo credentials (see below).
3. Click Create Project on the home dashboard.
4. Give your project a name, choose a type (e.g. Enterprise, SaaS), and set a deadline.
5. You are now inside the Project Workspace. Use the sidebar to navigate through the delivery phases: Discovery, Definition, Design, and Delivery.
6. Try the Product Guru — it analyses your project artifacts and suggests improvements in real time.

Demo Credentials

In the development environment, you can sign in with:

This account is auto-created on first login and has full administrative access in the development environment.

Useful Make Commands

The project includes a Makefile with shortcuts for common tasks:

Next Steps

• Read the System Architecture page to understand how the services fit together.
• See the Developer Guide for branching conventions, testing strategy, and PR workflow.
• Explore the API Reference for endpoint details and payload formats.