setup-ai-tutor

Set Up the AI Tutor Locally

Run the following commands to set up and start the AI Tutor locally.

Input

None required. Run from the repository root.

Process

1. Create Environment File

cp .env.example .env

Creates your local environment configuration from the example template.

2. Install Dependencies

uv sync

Installs all Python packages defined in pyproject.toml.

3. Start Database

docker-compose up -d db

Starts PostgreSQL in a Docker container.

4. Run Database Migrations

uv run alembic upgrade

Applies all pending database migrations.

5. Start Development Server

Starts the FastAPI server with hot-reload on port 8123.

6. Validate Setup

Check that everything is working:

Both should return {"status":"healthy"} responses.

Output

A running local AI Tutor instance.

Access Points

• Swagger UI: http://localhost:8123/docs
• Health Check: http://localhost:8123/health
• Database: localhost (Docker container)

Cleanup

To stop services:

Notes

• Port numbers and the exact docker-compose service name may differ — check docker-compose.yml, .env.example, and the project README for project-specific values before running.