File size: 1,615 Bytes
c59d808 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
---
title: Recipe Recommendation Chatbot API
emoji: 🥘
colorFrom: indigo
colorTo: pink
sdk: docker
pinned: false
license: mit
---
# Recipe Recommendation Chatbot
A GenAI-powered chatbot that recommends recipes based on available ingredients using RAG (Retrieval Augmented Generation).
## 🚀 Quick Start
```bash
# Clone repository
git clone https://github.com/A3copilotprogram/PLG4-Recipe-Recommendation-Chatbot.git
cd PLG4-Recipe-Recommendation-Chatbot
# Install dependencies
pip install -r requirements.txt
# Run the chatbot
python src/main.py
```
## 📁 Project Structure
- `backend/` - FastAPI backend with RAG pipeline
- `frontend/` - React frontend interface
- `data/` - Recipe datasets and embeddings
- `docs/` - Project documentation
- `notebooks/` - Jupyter notebooks for exploration
- `tests/` - Unit and integration tests
## 📚 Documentation
### Quick Start Guides
- **[Backend Setup](./backend/README.md)** - FastAPI server setup and configuration
- **[Frontend Setup](./frontend/README.md)** - React app development
### Troubleshooting
- **[Embedding Issues](./backend/docs/embedding-troubleshooting.md)** - Fix common dimension mismatch errors
- **[Documentation Index](./backend/docs/README.md)** - Complete documentation overview
### Architecture
- **[System Architecture](./docs/architecture.md)** - High-level system design
- **[API Documentation](./backend/docs/api-documentation.md)** - Detailed API reference
## 🤝 Contributing
See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for ways of working and contribution guidelines.
## 👥 Team
GenAI PLG 4 - Andela Community Program |