WasteEx

Project Overview

WasteEx is a web application designed to manage and track waste disposal and recycling activities in real-time. It aims to promote eco-friendly practices and increase awareness of waste management.

Features

• User authentication and authorization
• Dashboard for tracking waste metrics
• Notifications and reminders for waste disposal timings
• Integration with local recycling centers
• Detailed reports and statistics

Tech Stack

• Frontend: React, Redux, CSS
• Backend: Node.js, Express
• Database: MongoDB
• Deployment: Heroku/AWS

Installation Instructions

1. Clone the repository:

   git clone https://github.com/Kshitij-Raj-01/WasteEx.git

2. Navigate to the project directory:

   cd WasteEx

3. Install dependencies:

   npm install

4. Start the development server:

   npm start

Project Structure

WasteEx/
│
├── client/                # Frontend code
│   ├── src/               # Source files
│   ├── public/            # Static files
│   └── package.json
│
└── server/                # Backend code
    ├── src/               # Source files
    ├── models/            # Database models
    ├── routes/            # API routes
    └── package.json

Pages and Components

• Home: User dashboard with waste metrics.
• Login/Signup: Authentication pages.
• Reports: View statistical data.
• Profile: User settings and preferences.

API Documentation

Base URL

https://api.wasteex.com/v1

Endpoints

• GET /waste: Retrieve waste data.
• POST /waste: Submit waste disposal information.
• GET /users: Retrieve user information.
• POST /auth/login: User login.

Sample Request

curl -X POST https://api.wasteex.com/v1/auth/login -d '{"username":"user", "password":"pass"}'

Contribution Guidelines

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add new feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.