Building Locally¶
Follow these instructions to set up your development environment, build the gateway from source, and run it interactively.
π§© Prerequisites¶
- Python β₯ 3.11
make
- (Optional) Docker or Podman for container builds
π§ One-Liner Setup (Recommended)¶
This will:
- Create a virtual environment in
.venv/
- Install Python dependencies (including dev extras)
- Run the gateway using Gunicorn
π Manual Python Setup¶
This installs:
- Core app dependencies
- Dev tools (
ruff
,black
,mypy
, etc.) - Test runners (
pytest
,coverage
)
π Running the App¶
You can run the gateway with:
make serve # production-mode (Gunicorn) on http://localhost:4444
make dev # hot-reload (Uvicorn) on http://localhost:8000
make run # wrapper over uvicorn; pass --reload to enable auto-reload
./run.sh --reload # equivalent of 'make run' with explicit flags
Use make dev
during development for auto-reload on port 8000.
π Live Reload Tips¶
Ensure RELOAD=true
and DEV_MODE=true
are set in your .env
during development.
Also set:
π§ͺ Test It¶
You should see []
or registered tools (once added).