Documentation navigation

Installation

Docker

Docker Compose is the shortest path to a complete local installation:

git clone https://github.com/Orchetree/Orchetree.git
cd Orchetree
cp .env.example .env
docker compose up --build

The frontend is available at http://localhost:5173, the backend health check at http://localhost:8001/api/v1/health, GraphQL at http://localhost:8001/api/v1/graphql, and MCP at http://localhost:8001/mcp.

The Compose profile publishes backend container port 8000 on host port 8001 and persists PostgreSQL data in the orchetree-pgdata Docker volume.

Manual development setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env

Start the backend:

PYTHONPATH=src .venv/bin/uvicorn backend.main:app --port 8000 --reload

Manual development uses backend port 8000; the 8001 host port applies only to the Docker Compose profile.

Start the frontend:

cd src/frontend
pnpm install
pnpm dev

SDK requirements

The backend supports Python 3.11 and newer. The published Python SDK currently requires Python 3.13. The Node SDK supports Node.js 18 and newer; Node.js 22 is recommended for the full repository development environment.