Skip to content

Latest commit

 

History

History
155 lines (114 loc) · 5.08 KB

README.md

File metadata and controls

155 lines (114 loc) · 5.08 KB
Raw

E-Waste Recycling Solutions

JWT React Vite Tailwind CSS Chakra UI Redux Google Maps API MongoDB Express.js Cloudinary Brevo Vercel

E-Waste Recycling Solutions is a web app that simplifies e-waste disposal by providing an intuitive platform for scheduling pickups and tracking collection status in real time. Functioning like a ride-hailing service, users can easily request e-waste pickups from the comfort of their location.

The app features two roles: regular users who request pickups and collectors/riders who access and fulfill these requests. This structure ensures an efficient e-waste management process, promoting sustainable practices and empowering users to contribute to a cleaner planet.

E-Waste Dashboard

Table of Contents

Key Features

  • Secure User Authentication
  • Easy Scheduling
  • Pick-Off Locator
  • Real-Time Collection Tracking
  • Notifications

Usage

  1. Register and Sign Up - Visit the registration page and fill in your details.
  2. Login - Verify and use your credentials to log in.
  3. Request a Pick-up Collection - Click on 'Request Collection' and provide necessary
  4. Confirm the Pick-Up Location - Confirm your location for the pick-up.
  5. Track your Collection in Real-Time - Track your collection status in real-time via the dashboard.

Getting Started

Prerequisites

  • Node.js
  • npm

Installation

Clone the Repository

git clone https://github.com/CynthiaWahome/ewaste-recycling-solutions.git
cd ewaste-recycling-solutions

Configure Environment Variables

Create a .env file in the root directory and add the necessary environment variables

# Brevo API Keys
BREVO_API_KEY=
BREVO_SMTP_USER=
BREVO_SMTP_PASSWORD=

# Client URL
CLIENT_URL=

# Cloudinary Configuration
CLOUDINARY_API_SECRET=
CLOUDINARY_API_KEY=
CLOUDINARY_CLOUD_NAME=

# JWT Secret Key
JWT_SECRET_KEY=

# MongoDB Connection Strings
MONGO_URL=
MONGO_URL_PROD=

# Server Port
PORT=

# Mailgun Configuration
API_KEY=
DOMAIN=

Frontend Environment Variables

Create a .env file in the frontend directory and add the necessary environment variables for Vite:

VITE_GOOGLE_MAPS_API_KEY=your-google-api-key-here

Run the Application

To run both the frontend and backend of the application simultaneously, follow these steps:

  1. Frontend Setup

    • Navigate to the frontend directory: 
      cd frontend
    • Install frontend dependencies: 
      npm install
    • Start the frontend development server: 
      npm run dev

  2. Backend Setup

    • Open a new terminal window or tab, then navigate to the backend directory (if applicable): 
      cd backend
    • Install backend dependencies: 
      npm install
    • Start the backend development server: 
      npm run dev

License

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

Acknowledgments

Special thanks to Itsfoss0 for the support in developing this project.