Quick Start

Get RayRay up and running in minutes.

Prerequisites

• Node.js 18+
• Python 3.11+
• PostgreSQL (or use Docker)

1. Start the Backend

cd apps/api
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --reload

API will be available at http://localhost:8000

2. Start the Frontend

cd apps/web
npm install
npm run dev

App will be available at http://localhost:3000

3. Log In

Navigate to http://localhost:3000/login and use a demo account:

4. Upload a Document

1. Go to Documents in the sidebar
2. Click Upload
3. Select a PDF file
4. Wait for extraction to complete

5. Review Extractions

1. Click on an uploaded document
2. Review extracted data with source evidence highlighted
3. Approve or edit as needed

Run Tests

cd apps/api
pytest tests/ -v

Next Steps

• Architecture — Understand the system
• API Overview — Integrate with the API
• Auth System — Learn about authentication