Skip to content

CLAUDE.md

Latest commit

 

History

History
45 lines (29 loc) · 1.43 KB

CLAUDE.md

File metadata and controls

45 lines (29 loc) · 1.43 KB
Raw

CLAUDE.md

Guidance for Claude Code when working in this repo.

What this is

Backing project for a learnwithparam.com course. See README.md for the subject and walkthrough.

Quick start

uv sync              # install Python deps
cp .env.example .env # populate OPENROUTER_API_KEY
uv run python app.py # launch Gradio on http://localhost:7860

Default logins (seeded on first run)

  • admin / admin123 — access to admin tab + all roles
  • finance_user / finance123 — finance-tagged docs only
  • engineering_user / engineering123 — engineering-tagged docs only

These live in data/users.json after first launch. Delete data/ to reseed.

Smoke test

This repo is covered by the shared sweep in ../smoke_test_all.sh. To run just this one:

bash ../smoke_test_all.sh rbac-rag-chatbot

Expect: Gradio health check returns 200 + real LLM response when asking a finance question as finance_user.

Push workflow

Before every push, always:

  1. Run the smoke test above. It must pass.
  2. Verify .gitignore covers .env, __pycache__/, .venv/, data/, chroma_db/, .gradio/.
  3. git status — confirm no tracked secrets, no data artefacts, no local scratch files.
  4. Commit with a descriptive message.
  5. git push origin main — remote is git@github.com:learnwithparam/rbac-rag-chatbot.git.

Never force-push. Never commit .env or populated data directories.