🌿 Carbon Credit Trading Platform

📌 Introduction

Welcome to CarbonEase, a professional Carbon Credit Trading Platform built using the MERN (MongoDB, Express.js, React.js, Node.js) stack. It enables seamless buying, selling, and tracking of carbon credits in both compliance and voluntary markets, ensuring a secure and efficient trading experience.

---

🚀 Live Demo

🔗 Check out the live version: CarbonEase

📸 Screenshots

---

📖 Table of Contents

1. ✨ Features
2. 🛠️ Technologies Used
3. 🚀 Getting Started
4. 📁 Project Structure
5. 🔗 API Endpoints

---

✨ Features

✔️ User Authentication & Authorization (JWT-based security)
✔️ Gmail OTP Verification for Secure Login
✔️ Carbon Credit Listing & Management (Create, update, and delete listings)
✔️ Payment Integration for Buying Carbon Credits (Stripe)
✔️ Emissions & Credit Tracking Dashboard (Real-time analytics)
✔️ Integration with Carbon Credit Verification Services

---

🛠️ Technologies Used

🖥️ Frontend

• ⚛️ React.js (Component-based UI)
• 🏗️ ShadCN (Modern UI Components)
• 🌊 Tailwind CSS (Utility-first styling)
• 📜 React Context API (State management)

🔗 Backend

• 🚀 Node.js & Express.js (RESTful API)
• 🔐 JSON Web Tokens (JWT) (Secure authentication)
• 📧 Nodemailer (Gmail OTP verification)
• 💳 Stripe (Payment integration)

🗄️ Database

• 🛢️ MongoDB (NoSQL) (Flexible & scalable storage)
• 📊 Mongoose ORM (Schema-based validation)

---

🚀 Getting Started

📌 Prerequisites

Ensure you have the following installed:

• Node.js (v14 or later)
• MongoDB (Local or cloud instance)
• npm (Package manager)

📥 Installation

1️⃣ Clone the repository:

git clone https://github.com/nxtnilesh/carbonEase.git
cd carbonEase

2️⃣ Install dependencies:

npm install

3️⃣ Configure environment variables:

• Create a .env file in the root directory.
• Add the required variables:

MONGO_URI=your_mongodb_uri
JWT_SECRET=your_secret_key
SMTP_CONFIG=your_smtp_settings
STRIPE_API_KEY=your_stripe_key

4️⃣ Run the development server:

npm run dev

5️⃣ Access the application:
Visit http://localhost:3000 in your browser.

---

📁 Project Structure

carbonEase/
├── backend/   # Express.js backend
│   ├── controllers/   # Business logic
│   ├── models/        # Mongoose models
│   ├── routes/        # API routes
│   ├── utils/         # Utility functions
│   ├── config/        # Configuration files
│   └── index.js       # Entry point
│
├── frontend/  # React.js frontend
│   ├── components/    # Reusable components
│   ├── context/       # Context API for state management
│   ├── pages/         # Page components
│   ├── styles/        # Tailwind styles
│   ├── services/      # API call logic
│   └── App.js         # Main application file
│
└── README.md  # Project documentation

---

🔗 API Endpoints

Method	Endpoint	Description
POST	/api/auth/register	Register a new user
POST	/api/auth/login	User login
POST	/api/auth/verify-otp	OTP Verification
GET	/api/credits	Get all carbon credits
POST	/api/credits	Create a new listing
PATCH	/api/credits/:id	Update a listing
DELETE	/api/credits/:id	Delete a listing
POST	/api/payment	Process a payment

---

🌱 Empowering a sustainable future through technology!