Greener Foot(prints)

🍃 Travel situation emissions footprint calculator based on variables for how the user travels, with whom, and the route they want to go. Great for tracking your combustion footprint.
View Demo
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Helpful Tools & Resources
9. Acknowledgments

About The Project

This is an exploration into understanding what really comes out of those tailpipes every time we get behind the wheel. What is that six inches of black smoke before it dissipates into thin air? How is it measured and does anyone have reliable information as to what the impact is?

These are questions beyond this scope, however, my goal is to help start this discovery by showing you a measurement we all understand; pounds. Carbon pounds for gasoline are measured after combustion, where each carbon atom attaches with two oxygen atoms. The oxygen is the heaviest weight of the pair and gives the emission more weight than prior to the burning. Simply, one gallon of gasoline weighs approximately 6.25 lbs while one gallon of the emission equivalents weighs approximately 19.3 lbs.

This app will allow you to see how much carbon is emitted from your specific vehicle with your provided trip route. It also will not hold you accountable for the emissions of your passengers! This is a simple way to understand the carbon footprint of your vehicle with trips and measurements we make on a daily basis!

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

0. This project was tested using Firefox and Chromium browsers.

1. Setup a free (kinda) account on Amazon Web Services.

2. Get a free (sorta) maps API key at Google Maps Platform.

3. Get a free emissions API key at Carbon Interface.

4. Clone the repo by HTTPS:

   git clone https://github.com/marc-mccarthy/greener-footprints.git

   or via SSH:

   git clone git@github.com:marc-mccarthy/greener-footprints.git

   or by CLI:

   git clone gh repo clone marc-mccarthy/greener-footprints

5. Enter all your credentials into your '.env' file:

   • AWS Information

   AWS_ACCESS_KEY_ID='ENTER YOUR AWS ACCESS KEY ID HERE'
   AWS_SECRET_ACCESS_KEY='ENTER YOUR AWS SECRET ACCESS KEY HERE'
   AWS_REGION='ENTER YOUR AWS REGION HERE'
   AWS_BUCKET_NAME='ENTER YOUR AWS BUCKET NAME HERE'

   • Google Maps Information

   REACT_APP_GOOGLE_MAPS_KEY='ENTER YOUR GOOGLE MAPS API KEY HERE'

   • Carbon Interface Information

   CARBON_INTERFACE_KEY='ENTER YOUR CARBON INTERFACE API KEY HERE'

   • Session Random Key

   SERVER_SESSION_SECRET='ENTER RANDOM STRING OVER 8 CHARS HERE`

Installation

1. Install dependencies by running:

   npm install

2. Run the app with the commands:

   npm run server
   npm run client

(back to top)

Usage

• This application is designed to be used with on a desktop or laptop device.
• You can create a user and login to save your trips and vehicles.
• See and compare your carbon footprint over time.
• Hopefully gain a better understanding of the size of your carbon footprint.

(back to top)

Roadmap

• Add Jest unit testing
• Compare emissions to different vehicles
• Add various types of travel
• Scale views for different viewports
• Add a mobile view
• Add dates to your travel
• Host on AWS or Dokku/Digital Ocean

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make this community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Marc McCarthy - LinkedIn

Project Link: Greener Foot(prints)

(back to top)

Helpful

• Figma
• Amazon Web Services Documentation
• Google Maps Platform Documentation
• Carbon Interface Documentation
• README.md Composing
• Stack Overflow
• Material UI Documentation
• DB Designer
• Flaticon

(back to top)

Acknowledgments

I'd like to firstly thank my wife, Jessica! She put on a few hats over my time at Prime and this project wouldn't have nearly the commitment without her. She's been a superhero mom! Also, my children Mila, Madden and Reya. They were my inspiration to choose this topic and explore it so heavily. Shout out to my Prime staff and my Dorian cohort as we battled through the trenches together. They have been a wonderful group to grow with and share ideas and knowledge. I'd like to also thank all of you in the open source community for your contributions to projects I explored and got ideas from. Lastly, my dogs Roscoe and Remy, as they kept my feet warm on the late nights of studying!

Credit for icons used:

• Carbon dioxide icons created by wanicon - Flaticon
• Carbon footprint icons created by Freepik - Flaticon
• Co2 icons created by Freepik - Flaticon

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)