Carbon Footprint Calculator

A web page to contribute to the enviroment.

Welcome to the project.

This project is an open-source about an online calculator that quantify the amount of carbon foorptint a person or small organization generate through the year.

The intention of this open-source is to be coding friendly for newbies so everyone can easily contribute.

Table of Content

• Objective
• About
• Inspiration
• Documentation
• Features
• Contributing
• Installation
• Licence

Objective

The main propurse is to create a web-page that makes 'helping the enviroment' easy for people. Right now is oriented to calculating you carbon footprint but it should cover way more topics in the future such as making easy to post and join volunteer programs near you or in a remote way. It should basically the reference web in terms of enviroment and that is why making it open-source makes so much sense, a web page about helping the planet build by everyone and own of no organization or interest. It should provide information, raise awareness, news, easy communication between people and create a strong community.

About

There is no unique path or objective for this project apart from something related with the enviroment. I started with a carbon footprint calculator because I had already the calculations from an other project. But the main concept of this project it is yet not decided. It can be whatever we (the contributors) want it to be.

The possibilities are endless. It can go from this carbon footprint calculator all the way to an index volunteer project page.

Carbon Footprint is a page where the main goal is to help the enviroment, raising awareness, making it easy for people to help the enviroment.

The project is still in early development. If you have any suggestions, file an issue or even better, start contributing!

Inspiration

I thought that an open-source for helping the enviroment it was something that just make sense. People contributing for the great of all. All the money (in case of donations) gets to where it needs to go. No middlemans where the money is lost. A cool page to raise awareness and try to change the world (or at least make it a bit better 😊 )

Documentation

Under construction.

Features

Individual Calculator | Buisness Calculator | Result Calculator | Demo |

• Cool landing page with react three fiber.
• Calculate the carbon footprint of a person
• Calculate the carbon footprint of a small organization
• Deliver information of how to contribute to the enviroment through:
  • Information Page
  • Contribute Page

Contributing

Under construction.

If you are interested in contribute just send me a message or talk to me on twitter (I answer quicker on twitter) or file an issue saying what you want to work on.

Although the rules are pretty simple, if you think you can improve something of the page, you do it. If you think you can write a cool feature, you do it. If you can clean code or make reusable components, you do it. All ideas are welcome.

The only rule is to make the design super simple (minimalist) and easy to use by the user. :)

For now it is a pretty simple project, so it shouldn't be hard find features to add or fix bugs. I am going to write a to-do list of things to add or fix depending on its difficulty so you can take the ones that suits you or seems more fun to you.

Feel free to jump into the code and start tinkering with it so you understand how it works.

Beginner

• Do Information Page.
• Do Contribute Page.
• Add information button on the quiz questions so that on hover explains better the question.

Advance

• Fix Responsive layout through the page including the bugs produced by animations.
• Add different languages i18n.
• Make a simple country selector so the calculator it is more accurated.
• Identifies the ip's country.
• Improve rules of quiz. So you can't continue until you fill all inputs.
• Add Testing.
• Add blog-posts for information or discussions. --> so you would also need to add authentification.
• Create CMS so no-programmers contributers can easily modify the data of each country.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contributors

Alfonso Achiaga 💻

Pranav Jain 💻

José Manuel 💻 🐛

Installation

cd carbon-footprint
yarn install
yarn start

License

MIT

Reason to contribute to the project:

Although there already a lot of footprints calculator online I beleave that we, the dev comunity, can create an open-source calculator way better than the ones that already exists. And it is a good way for a first contact with contributions to open-source projects.

And who knows... maybe at the end we come up with some cool ideas for the page and make a cool open-source enviroment project that recieve donations and really help the enviroment.

Acknowledgements

Icon by Freepik.