Skip to content

Latest commit

ย 

History

History
57 lines (37 loc) ยท 2.24 KB

File metadata and controls

57 lines (37 loc) ยท 2.24 KB
Home

Greeney: Own Your Emissions

Greeney is a carbon footprint tracker that helps you measure, understand, and reduce your transportation-related emissions. The app calculates your carbon footprint from various transportation activities and provides insights to make more eco-conscious choices.

The app is built with Next.js, TypeScript, Tailwind CSS on the frontend and Flask, Python for the backend API services.

๐Ÿš€ Features ๐Ÿš€

  • Calculate carbon emissions from multiple transportation categories (Uber/Lyft rides, food deliveries, flights) in kg COโ‚‚e
  • Track your historical carbon footprint data and energy consumption (kWh)
  • Visualize your carbon impact and distance traveled (miles) through charts and metrics

๐Ÿงฎ Emissions Calculation Method ๐Ÿงฎ

Carbon emissions (COโ‚‚e) = Carbon Intensity (g COโ‚‚/kWh) ร— Energy Consumed (kWh)

โšก๏ธ Tech Stack โšก๏ธ

  • Next.js
  • TypeScript
  • Tailwind CSS
  • ShadCN
  • Flask
  • Python
  • Google APIs (Distance Matrix, Geocoding, Gmail,OAuth 2.0)

๐Ÿƒ Run Locally ๐Ÿƒ

To run the project, follow these steps:

  1. Clone the repository
git clone https://github.com/yourusername/greeney.git
  1. For the frontend setup:

See instructions in the web-client folder README.md

  1. For the backend setup:

See instructions in the backend folder README.md

  1. Open http://localhost:3000 with your browser to see the frontend and http://localhost:5000 for the API.

๐Ÿค Contributing ๐Ÿค

Contributions are welcome! If you have any questions, bug findings, or feature requests, feel free to open an issue.

๐Ÿ“š Acknowledgements ๐Ÿ“š

Lannelongue, L., Grealey, J., Inouye, M. (2021). Green Algorithms: Quantifying the Carbon Footprint of Computation. Advanced Science, 2100707. https://doi.org/10.1002/advs.202100707

๐Ÿ“„ License ๐Ÿ“„

This project is supported by the MIT License.

โš ๏ธ Disclaimer โš ๏ธ

Greeney is a project for educational and environmental awareness purposes. The carbon emission calculations are estimates based on available data and should not be considered as exact measurements for regulatory or compliance purposes.