Skip to content

MiraclePallavi/CarbonReducer

Repository files navigation

🌱 CARBONREDUCER

Transforming Data into a Greener Future


🛠️ Built with the tools and technologies



📑 Table of Contents


🔍 Overview

CarbonReducer is a full-stack, AI-powered platform that tracks users' carbon emissions based on their habits and lifestyle choices. It offers personalized insights, visual analytics, and practical recommendations to promote more sustainable living.

🚀 Getting Started

📋 Prerequisites

This project requires the following dependencies:

  • Programming Language: TypeScript
  • Package Manager: Npm, Pip

🛠️ Installation

Build CarbonReducer from the source and install dependencies:

  1. 🔁 Clone the repository:
git clone https://github.com/MiraclePallavi/CarbonReducer
  1. 📁 Navigate to the project directory:
cd CarbonReducer
  1. 🔧 Install frontend dependencies:
npm install
  1. 🐍 Set up the Python backend:
cd python-backend
python -m venv .venv
source .venv/bin/activate  # On Windows use .venv\Scripts\activate
pip install -r requirements.txt
  1. ⚙️ Configure Appwrite (authentication and DB):

Make sure the Appwrite server is running and your .env.local file contains:

NEXT_PUBLIC_APPWRITE_ENDPOINT=https://<your-endpoint>
NEXT_PUBLIC_APPWRITE_PROJECT=<your-project-id>
  1. 🔌 Start the servers:

Start the backend server:

cd python-backend
uvicorn app:app --reload

Start the frontend server:

npm run dev

✅ The application will be running at http://localhost:3000


Let me know if you also want the README header or feature section code to match the style you showed earlier.

🚀 Features

  • 🌎 Tracks and compares personal carbon footprint over time
  • 📊 Visualizes trends and emissions statistics
  • 🧾 Provides actionable recommendations to reduce emissions
  • 🔐 Authenticated user sessions using Appwrite
  • ☁️ MongoDB storage for historical user data

🧰 Tech Stack

  • Frontend: React, Next.js, Tailwind CSS, shadcn/ui
  • Backend: FastAPI, Python (NumPy, pandas, scikit-learn)
  • Auth & DB: Appwrite, MongoDB with Mongoose
  • Dev Tools: TypeScript, Zod, ESLint, Axios, date-fns

🤝 Contributing

Feel free to open issues or submit pull requests! Contributions are welcome.


📄 License

This project is licensed under the MIT License.

About

Carbon Tracker

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors