CodeCompass

Interactive documentation with RAG-enabled chat over your codebase.

• web/ — Next.js frontend + API routes
• backend/ — FastAPI GraphRAG indexing/retrieval service

The frontend calls the backend over HTTP via BACKEND_URL (/chat/stream, /repos/index). Backend CORS allows http://localhost:3000.

Setup

# frontend
cd web && npm install && cp .env.example .env.local   # then fill it in

# backend
cd backend && python3 -m venv .venv && . .venv/bin/activate
pip install -r requirements.txt && cp .env.example .env   # then fill it in

The backend also needs Ollama installed — its startup checks pull the models it needs.

Run

./dev.sh          # both: web on :3000, backend on :8000

Or separately:

cd web && npm run dev
cd backend && . .venv/bin/activate && python3 main.py

Per-project details: web/README.md, backend/README.md.