Smart Librarian

Smart Librarian is a RAG (Retrieval Augmented Generation) system that recommends books based on user preferences. The project consists of several modules: backend (Express), worker (Redis + OpenAI), frontend (React/Vite), and Python scripts (ChromaDB).

📂 Modules

• Backend
• Worker
• Frontend
• Scripts

🚀 Quickstart

1. Clone the project

git clone <repo-url>
cd Smart-Librarian

2. Create .env file

OPENAI_API_KEY=sk-...
REDIS_URL=redis://redis:6379
CHROMA_URL=http://chromadb:8000
CHROMA_COLLECTION=books
OPENAI_BUDGET_LIMIT_USD=5

3. Run with Docker Compose

docker compose up -d --build

4. Access the services

• UI: http://localhost:5173
• API Backend: http://localhost:3001
• ChromaDB: http://localhost:8000

📂 Documentation

• Backend
• Worker
• Frontend
• Scripts
• Architecture
• Troubleshooting

🧪 Quick test

• Backend health check:

curl http://localhost:3001/api/health

• Smoke test scripts:

cd scripts
python smoke_test.py

📜 License

Educational project (lab/assignment).