priyanshu2631/prithwe

PrithWe is a platform dedicated to helping individuals and businesses calculate and reduce their carbon footprint. We provide tools and resources to promote sustainability and environmental consciousness in everyday practices.

PrithWe

PrithWe is a full-stack web application built on the PERN stack (PostgreSQL, Express, React, Node.js) designed to help households and businesses calculate their carbon footprints. This project was developed as a college project to promote environmental awareness and action.

Table of Contents

• Introduction
• Features
• Technologies Used
• Installation
• Usage
• Motivation
• License

Introduction

PrithWe allows users to calculate their carbon footprint based on various parameters. It provides detailed insights and suggestions on how to reduce their carbon emissions. The name "PrithWe" is derived from "Prithvi" (Earth) and "We," emphasizing collective action and collaboration.

Visit the live application here.

Features

• User authentication and authorization
• Carbon footprint calculator for households and businesses
• Detailed reports and donut chart representation.
• Responsive design for all devices
• User-friendly interface

Technologies Used

• Frontend: React.js, Tailwind CSS
• Backend: Node.js, Express.js
• Database: PostgreSQL
• Hosting: Render
• Version Control: Git, GitHub

Installation

Follow these steps to set up the project locally:

1. Clone the repository:

   git clone https://github.com/yourusername/prithwe.git

2. Navigate to the project directory:

   cd prithwe

3. Install backend dependencies:

   npm install

4. Install frontend dependencies:

   cd ./client
   npm install

5. Set up environment variables:

   Create a .env file in the server directory and add your database details:

   PG_USER=your_user_name 
   PG_HOST=your_host_name 
   PG_DATABASE=your_database_name 
   PG_PASSWORD=your_password
   PG_PORT=5432
   SESSION_SECRET=your_secret
   MAIL=your_mail
   APP_PASSWORD=your_app_password
   ADMIN_MAIL=admin_mail
   ADMIN_PASS=admin_password
   GEMINI_API_KEY=your_api_key

6. Start the backend server:

   cd ./server
   node index.js

7. Start the frontend development server:

   cd ./client
   npm run dev

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

Usage

1. Register a new account or log in with an existing account.
2. Choose whether you want to calculate the carbon footprint for a household or a business.
3. Fill in the required information in the form.
4. View the calculated carbon footprint and suggestions for reducing emissions.

Motivation

It was a college project and the motivation behind PrithWe is to provide a tool that helps individuals and businesses become more aware of their environmental impact. By understanding their carbon footprint, users can take actionable steps towards reducing their emissions and contributing to a healthier planet.

License

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