Skip to content

README.md

Latest commit

 

History

History
70 lines (47 loc) · 1.86 KB

README.md

File metadata and controls

70 lines (47 loc) · 1.86 KB
Raw

Development — Native (No Docker)

Use this when you want to run everything directly on your host machine without Docker — the fastest setup for local development with full debugger support.

Requirements

  • Python 3.11+
  • Poetry
  • PostgreSQL with pgvector extension
  • Redis

Tip: If you don't have Python and Poetry installed, use the helper scripts in development/native/scripts/:

  • Linux: bash development/native/scripts/install_python.sh
  • Windows: development\native\scripts\install_python.bat

Quick Start (via setup.py)

The fastest way to get started is using the project CLI from the repository root:

python3 setup.py

This automates setup tasks like installing dependencies, configuring the environment, and running migrations.

Manual Setup

1. Install Python dependencies

cd backend
poetry install

2. Configure environment variables

cp backend/.env.example backend/.env

Edit backend/.env and fill in your local database credentials:

  • POSTGRES_SERVER=localhost
  • REDIS_CACHE_HOST=localhost, REDIS_BROKER_HOST=localhost, etc.

3. Run database migrations

cd backend
poetry run alembic upgrade head

4. Start the services

Open separate terminal windows for each process (all commands run from backend/):

# API (terminal 1)
poetry run uvicorn src.main:app --host 0.0.0.0 --port 8000 --reload

# Celery Worker (terminal 2)
poetry run celery -A src.worker worker --loglevel=info

# Celery Beat / Scheduler (terminal 3)
poetry run celery -A src.worker beat --loglevel=info

Tips

  • Use development/compose/infra-only to spin up Postgres and Redis in Docker if you don't have them installed locally.
  • Use Honcho to start all processes in a single terminal if desired.