Skip to content

Latest commit

 

History

History
175 lines (124 loc) · 4.95 KB

README.md

File metadata and controls

175 lines (124 loc) · 4.95 KB
Raw

Watchers Forks Star

Issue Open Pull Request

License

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

  • 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

Demo

Final_demo_ZeroSpoil.mp4

Installation

Prerequisites

Before running, Quine-ZeroSpoil, 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/your-username/Quine-ZeroSpoil.git
cd Quine-ZeroSpoil

  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

  1. 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

Contributing

We welcome contributions to enhance and improve Quine-ZeroSpoil! Feel free to submit issues, feature requests, or pull requests. Please adhere to our Code of Conduct.

License

This project is licensed under the MIT License.