Getting Started

Modulo is a self-hosted platform for governed SDLC agent pipelines. These docs walk you through setup, configuration, and building your first pipeline.

Prerequisites

Docker & Docker Compose v2.20+
Python 3.12+ and uv (or pip)
A GitHub account (for GitHub connector)

Quick Start

# Clone the repo
git clone https://github.com/farnalabs/modulo
cd modulo

# Start Postgres and Redis
docker compose -f docker-compose.local.yml up -d

# Generate a SECRET_KEY
python -c "import secrets; print(secrets.token_hex(32))"

# Create backend/.env with your keys (see Installation guide)
# Run migrations
cd backend
uv run alembic upgrade heads

# Start the backend
uv run uvicorn modulo.api.main:app --reload --port 8000

# In another terminal, start the frontend
cd frontend
npm run dev

Open http://localhost:5173 and log in with admin:admin.

Next Steps

Read the installation guide for full setup
Learn about pipelines and nodes
Connect your first connector
Configure a model backend

Next: Architecture