🍽️ SharePlate - Food Waste Reduction Platform

Connecting surplus food with those in need! 🌍

🌐 Live Demo | 💻 Frontend Repo | 🔧 Backend Repo

---

📝 Table of Contents

• About the Project
  • Features
  • Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Running Locally
• Usage
• API Documentation
• Deployment
• Contributing
• License
• Contact
• Acknowledgments

---

🚀 About the Project

SharePlate is a platform designed to reduce food waste by connecting restaurants with surplus food to NGOs and individuals who can utilize it. The platform focuses on real-time food listing, reservation management, and location-based search to ensure no food goes to waste.

🌟 Features

• User Authentication: Secure login and registration with JWT tokens 🔐
• Food Listings: Restaurants can create and manage food listings 🍕
• Reservation System: NGOs/Individuals can reserve available food 🛒
• Real-time Analytics: Charts and statistics for admin dashboard 📊
• Location-based Search: Google Maps integration for finding nearby listings 🗺️
• Image Upload: Cloudflare R2 integration for food listing photos 📸
• Responsive Design: Mobile-friendly interface 📱
• User Roles: Three user types (Restaurant, NGO/Individual, Admin) 👥

🛠️ Tech Stack

Frontend

• React.js
• React Router
• Chart.js
• Google Maps API
• Framer Motion
• Notistack (Snackbars)

Backend

• Node.js
• Express.js
• MongoDB
• Mongoose
• JWT Authentication
• Nodemailer (OTP)

DevOps

• Vercel (Deployment)
• Cloudflare R2 (Image Storage)
• MongoDB Atlas (Database)

---

🛠️ Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16 or higher)
• MongoDB Atlas account
• Google Maps API key
• Cloudflare R2 credentials

Installation

1. Clone the repositories:

   git clone https://github.com/Shripad735/shareplate-frontend.git
   git clone https://github.com/Shripad735/shareplate-backend.git

2. Install dependencies:

   • For Frontend:

     cd shareplate-frontend
     npm install

   • For Backend:

     cd shareplate-backend
     npm install

3. Set up environment variables:

   • Create .env files in both shareplate-frontend and shareplate-backend directories.
   • Add the required environment variables (refer to the respective .env.example files).

Running Locally

1. Start the backend server:

   cd shareplate-backend
   npm start

2. Start the frontend development server:

   cd shareplate-frontend
   npm start

3. Open your browser and navigate to http://localhost:3000.

---

💽 Usage

User Roles

1. Restaurants:

   • Create and manage food listings
   • View reservations
   • Manage active listings
   • View statistics

2. NGOs/Individuals:

   • Browse available food listings
   • Make reservations
   • Track pickup status
   • View nearby listings on map

3. Admin:

   • Manage all users
   • View platform statistics
   • Monitor all listings and reservations

---

📚 API Documentation

The backend API follows RESTful principles and includes the following main endpoints:

Authentication

• POST /api/auth/register - User registration
• POST /api/auth/login - User login
• POST /api/auth/forgot-password - Password reset initiation
• POST /api/auth/validate-otp - OTP validation
• POST /api/auth/reset-password - Password reset

Food Listings

• GET /api/food-listings - Get all listings
• POST /api/food-listings - Create new listing
• PUT /api/food-listings/:id - Update listing
• DELETE /api/food-listings/:id - Delete listing

Reservations

• POST /api/reservations - Create reservation
• GET /api/reservations - Get all reservations
• PUT /api/reservations/:id/pickup - Mark reservation as picked up
• DELETE /api/reservations/:id - Cancel reservation

Statistics

• GET /api/stats - Get platform statistics

---

🚀 Deployment

The project is deployed on Vercel with the following configuration:

1. Backend Deployment:

   • Uses vercel.json configuration
   • Environment variables set in Vercel dashboard
   • Automatic deployments from main branch

2. Frontend Deployment:

   • Separate Vercel project
   • Environment variables for API endpoints
   • Automatic deployments from main branch

---

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please make sure to update tests as appropriate and follow the code style guidelines.

---

📜 License

Distributed under the MIT License. See LICENSE for more information.

---

📞 Contact

Shripad Deshmukh

• Email: [email protected]
• GitHub: Shripad735
• LinkedIn: Shripad Khandare

---

🙏 Acknowledgments

• Vercel for hosting
• Cloudflare R2 for image storage
• Google Maps API for location-based features
• Chart.js for analytics
• Framer Motion for animations