CarbonWise

Description

Welcome to the CarbonWise, a LLM powered web app that calculates the carbon footprint of a family and gives advisory to reduce the carbon footprint. CarbonWise harnesses the formidable capabilities of OpenAI's Language Model (LLM) via the OpenAI API to empower individuals to make informed decisions for a greener future.

Our app facilitates people to take actions for reducing their carbon footprint by asking users about their daily activity data such as number of people in household, electricity consumption, heating source, distance travelled using various mediums and lifestyle. This data is then processed through OpenAI's Language Model to generate personalized recommendations aimed at reducing users' environmental impact and tackling climate change.

Through our web platform, we seek to increase individuals' awareness of their environmental actions and offer tailored suggestions to decrease the pollution emitted by their daily activities.

CarbonWise-Demo.mp4

Table of Contents

• Features
• Technologies
• Installation Guide
• Configuration
• Usage
• Credits
• License

Features

• Clean and easy to navigate User Interface.
• Calculate Carbon Footprint impact: Accurate calculation of carbon footprint three aspects energy consumption, lifestyle choices and transportaion.
• Personalized insights: Break down of footprint by category, highlighting areas with the most significant impact.
• Actionable advice: Actionable steps to reduce carbon footprint effectively using generative ai based on provided data.

Technologies

This project is built using the following technologies:

• React: Frontend library for building user interfaces.
• Vite: Frontend build tool for faster development.
• Tailwind CSS: Utility-first CSS framework for styling.
• Express: Backend framework for handling server-side logic.
• Langchain: Language model used for providing carbon footprint reduction advice.

Installation Guide

Clone this repository

git clone https://github.com/PRASUN-SITAULA/carbonWise.git

Go into the repository

cd carbonWise

Install packages

Navigate to the frontend and backend directory

yarn install

Run the server

Navigate to the backend directory.

yarn start

Run the Frontend

Navigate to the frontend directory

yarn dev

Visit the Page

Open your browser and navigate to http://localhost:5173.

Configuration

• Obtain your OpenAI API key: Visit OpenAI to get your API key.

• Create a .env file in the backend folder of the project and add the following:

OPENAI_API_KEY=your-api-key-goes-here
PORT=3000

Usage

Credits

Prasun Sitaula

Subash Lamichhane

License

This project is licensed under the MIT License - see the LICENSE file for details.