README.md

metadata

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

# 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 - FastAPI server setup and configuration
• Frontend Setup - React app development

Troubleshooting

• Embedding Issues - Fix common dimension mismatch errors
• Documentation Index - Complete documentation overview

Architecture

• System Architecture - High-level system design
• API Documentation - Detailed API reference

🤝 Contributing

See CONTRIBUTING.md for ways of working and contribution guidelines.

👥 Team

GenAI PLG 4 - Andela Community Program