Skip to content

README.md

Latest commit

 

History

History
40 lines (29 loc) · 1.54 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.54 KB
Raw

Study Assistant

A local, single-user RAG study assistant over course materials (lecture slides, papers, notes). It answers questions with synthesis from Claude, grounded in retrieved sources, with citations back to the exact source slide or page. Ingestion and retrieval run entirely on-machine, offline, and for free; only answer generation calls the Anthropic API.

Status

Early scaffolding (Phase 0 — Foundations). The repo currently contains the uv workspace root, the shared packages/rag_core/ library, and the Postgres + pgvector dev stack. Later phases add the CLI, MCP server, FastAPI backend, and React frontend.

Prerequisites

  • uv — curl -LsSf https://astral.sh/uv/install.sh | sh
  • Docker (Docker Desktop on macOS) for Postgres + pgvector
  • pre-commit — uv tool install pre-commit

Quickstart

cp .env.example .env          # then edit secrets
uv sync                       # resolve + install the workspace
pre-commit install            # enable lint/format/typecheck hooks
docker compose up -d          # start Postgres with the vector extension
uv run pytest                 # run the test suite

Verify pgvector is live:

docker compose exec db psql -U "$POSTGRES_USER" -d "$POSTGRES_DB" -c '\dx'

The vector extension should appear in the list.