Adity20 / FoodFavor

Transforming leftovers into culinary wonders!
Unleash your kitchen creativity, share delightful recipes, and champion a zero-waste lifestyle.
Join us in savoring sustainability, one delicious dish at a time! 🌍🍽️

Table of Contents

• Features
• Demo
• Installation
• Dependencies
• Contributing
• License

Features

• Recipe Revival

  Rediscover magic in leftovers with creative

  Sample UI of Recipe Generator

  

• Community Connection:

  Join a vibrant community of food enthusiasts, sharing recipes, stories, and culinary adventures.

  Sample UI of Community Connection

  

• Donation Hub:

  Easily connect with local charities and food banks to share excess food and reduce waste.

  Sample UI of Donation Hub

  

• Expiration Alerts:

  Receive timely notifications about expiring ingredients to optimize your pantry.

  Sample UI of Expiry Track

  

Installation

Prerequisites

Before running, FoodFavor, you will need an OpenAI API key if the project utilizes OpenAI's services. You can obtain an API key by registering on the OpenAI platform.

Setup

FrontEnd

1. Clone the repository:

   git clone https://github.com/Adity20/FoodFavor.git
   cd FoodFavor

2. Change directory to frontend

   cd frontend/

3. Installation of node packages

    yarn

4. Running the project:

   yarn run dev

Backend

1. Change directory to backend

   cd backend/

2. Installation of node packages

    pip install -r requirements.txt

3. Setting up .env in root backend folder for saving openai api key

• Create a .env file

    # inside .env file
    OPENAI_API_KEY=******************************* # Your key 

4. Running the project:

   python manage.py runserver

Dependencies

Frontend

• Vite
• React
• React Router
• React Icons
• shadcn/ui
• Tailwind CSS

Backend

• Openai
• Django Rest Framework
• django-jazzmin
• django-spectacular