BoardPilot

BoardPilot is a private-deployment RAG support workbench for hardware teams. The MVP focuses on proving that source material can be ingested, chunked, retrieved, reranked, cited, reviewed, and measured through an evaluation loop.

Current MVP Slice

• FastAPI backend with product/source CRUD, ingestion, ask, evidence, answer, review, and eval endpoints.
• Fake LLM, embedding, reranker, and OCR providers so the full loop runs without external credentials.
• SQLAlchemy-backed persistence for MVP records, with in-memory service hydration retained for local development and test ergonomics.
• Parser-aware ingestion for Markdown, webpage snapshots, CSV/FAQ, logs, uploaded image/manual descriptions, approved FAQs, and PDF text extraction.
• Next.js workbench with Ask, Sources, Eval, and Review pages.
• Docker Compose stack definitions for web, api, worker, Postgres/pgvector, and Redis with health-gated startup.

Local API

cd api
python3 -m venv .venv
source .venv/bin/activate
pip install ".[test]"
uvicorn app.main:app --reload --port 8000

Run tests:

cd api
pytest

Run migrations:

cd api
alembic upgrade head

Local Web

cd web
npm install
npm run dev

The web app expects NEXT_PUBLIC_API_BASE_URL=http://localhost:8000.

Docker Compose

cp .env.example .env
docker compose up --build

The API container runs Alembic migrations before serving, then the web and worker wait for API health. SQLAlchemy repositories persist the MVP record groups, the Redis worker handles queued ingestion jobs, and the service layer still uses some in-memory hydration as an internal compatibility bridge.

Use .env.example as the documented deployment template. If local ports are already occupied, set BOARDPILOT_API_HOST_PORT or BOARDPILOT_WEB_HOST_PORT before running Compose. For private deployments, set BOARDPILOT_API_KEY and either mirror the same value to NEXT_PUBLIC_BOARDPILOT_API_KEY or issue a signed role-bound token with POST /sessions and provide it as NEXT_PUBLIC_BOARDPILOT_SESSION_TOKEN for the bundled workbench. Set BOARDPILOT_USERS_JSON when session issuance should be restricted to an operator-managed user/role map. BOARDPILOT_API_HOST and BOARDPILOT_API_PORT control the API bind address inside the container.