Skip to content

Calculate your carbon footprint 👣 Food, transport, purchases, electricity and streaming.

License

Notifications You must be signed in to change notification settings

marlonemmerich/carbon-footprint

 
 

Repository files navigation

Carbon Footprint Diagnostic 👣🩺

Contributor Covenant Build Status

Calculate your carbon footprint. Food, transport, purchases, electricity and digital activities like streaming.

Used in NMF.earth open-source project. Can be found on NPM.

Units 🌐

Unit of measurement used in the project are following the International System of Units to avoid confusion and make everything easy to remember : seconds for time, energy in joules, mass in kilogram, distance in meters, memory in bits.

Therefore meter is used instead of kilometer for distance and any mass is in kilogram.

Install 📦

yarn add carbon-footprint or npm install carbon-footprint

How to use 🔥

import { transport } from 'carbon-footprint' ... const emission = kilometer * transport.fossilFueledCar;

If you want to see how we use this module, check the NMF.earth app repo.

Source ℹ️

You can verify any number. A link can be found inside corresponding file.

Contribution 🙋

Any Contribution is welcome!

Please read this if you want to contribute.

Lint + typescript :

npm run lint and : npm run format

Workflow

To publish to npm, just create a new release.

©️ Open source - licence

Repository and contributions are under GNU General Public License v3.0

About

Calculate your carbon footprint 👣 Food, transport, purchases, electricity and streaming.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 94.9%
  • JavaScript 5.1%