CoolFace
Apppublic

jessejohnson/plg4-dev-server

sourceHugging Facemitupdated 1y agoView on Hugging Face
0likes
App README

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 for ways of working and contribution guidelines.

๐Ÿ‘ฅ Team

GenAI PLG 4 - Andela Community Program