Swadeshit27 / Save-Before-Spoil

Home Page:https://save-before-spoil.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Readme

SAVE BEFORE SPOIL

Save Before Spoil -- Submitted at Hack4Bengal 3.0 by Team S2K2 💖

Food Ingredients Waste Management

Overview

This platform is designed to reduce food waste by connecting shopkeepers/retailers with food banks. The platform offers features such as product management, recipe suggestions, and notifications for expiring products. Users can sign up as either Shopkeepers/Retailers or Food Banks, each accessing different functionalities.

Features

Shopkeepers/Retailers

  • Product Management: Save and manage product details including price, name, and expiry date.
  • Notifications: Receive email notifications for expiring products via Node Mailer.
  • Recipe Suggestions: Get recipe recommendations for soon-to-expire products using Gemini AI.
  • Donation Guidance: Receive suggestions for nearby food banks to donate expiring products.
  • Waste Management: Get advice on reusing or disposing of expired food items.

Food Banks

  • Retailer Listings: View a list of retailers with available products.
  • Suggested Foods: See suggested food items and expiring products.
  • Discounted Purchases: Purchase soon-to-expire products at reduced prices.
  • Waste Management: Receive suggestions for managing expired ingredients using AI.

Technologies Used

  • Frontend: React.js
  • Backend: Node.js
  • Database: Firebase
  • Authentication: Firebase Authentication
  • AI Integration: Gemini AI for recipe recommendations
  • Email Notifications: Node Mailer
  • Location Services: Google Location APIs for calculating shortest distances to food banks

Shopkeepers/Retailers

  1. Sign Up: Register as a Shopkeeper/Retailer.
  2. Dashboard: Access the dashboard to manage your products.
  3. Add Products: Add product details including price, name, and expiry date.
  4. Notifications: Receive email notifications for expiring products.
  5. Recipe Suggestions: View recipe suggestions for soon-to-expire products.
  6. Donate: Find nearby food banks for donations.

Food Banks

  1. Sign Up: Register as a Food Bank.
  2. Dashboard: Access the dashboard to view available retailers and products.
  3. Suggested Foods: See suggested foods and expiring products.
  4. Purchase: Buy soon-to-expire products at discounted prices.

Contribution

We welcome contributions to improve the platform. Please follow these steps:

  1. Fork the repository.

  2. Create a new branch: git checkout -b feature-branch-name.

  3. Make your changes and commit them: git commit -m 'Add some feature'.

  4. Push to the branch: git push origin feature-branch-name.

  5. Submit a pull request.

  6. React Vite Project

License React Vite

Table of Contents

About

This project is a web application developed using React and Vite. It is designed to provide an optimized and fast development experience with a modern build tool.

Features

  • Fast development with Vite
  • Hot Module Replacement (HMR)
  • React components
  • State management
  • Routing
  • Environment configuration

Prerequisites

  • Node.js (>= 12.x)
  • npm (>= 6.x) or Yarn (>= 1.x)

Installation and Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/react-vite-project.git
    cd react-vite-project
  2. Install dependencies:

    npm install
    # or
    yarn install

Usage

Development

To start the development server with hot module replacement:

npm run dev
# or
yarn dev



## License
This project is licensed under the MIT License. See the `LICENSE` file for details.

## Contact
For any questions or feedback, please contact us at support@example.com.

---

By following this readme, users can easily set up, use, and contribute to the Food Donation and Waste Management Platform.

About

https://save-before-spoil.vercel.app


Languages

Language:JavaScript 99.6%Language:HTML 0.3%Language:CSS 0.1%