Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.85 KB

README.md

File metadata and controls

62 lines (37 loc) · 2.85 KB

Carbon Footprint for Google Maps

A browser extension that displays carbon footprint information in multiple map services.

Downloading and Using the Latest Stable Version

To download and install the extension to your favorite browser, visit Carbon Footprint's page in your browser's extension/add-on gallery/store:

Minimum Node Requirements

  • Node >= 6.0.0
  • npm >= 5.3.0

Building and Using Beta Versions

  • clone this repository

  • run npm install

  • run num run group or num run groupFirefox or num run groupChrome or num run groupSafari or num run groupWebext

  • run num run group:debug or num run groupFirefox:debug or num run groupChrome:debug or num run groupSafari:debug or num run groupWebext:debug to keep all debug statements and comments.

  • for chrome, load the unpacked extension from the Build/Chrome folder

  • for firefox, Change directory into Build/Firefox and run jpm run -b firefox_edition_name, to use this extension in specific firefox edition (firefox for simple firefox browser).

  • for WebExtension, Change directory into Build/WebExtension-Firefox/ and than run web-ext run -f firefox_edition_name to use this extension in specific firefox edition (firefox for simple firefox browser).

  • for safari, load folder with extension .safariextension into Extension Builder Develop -> Show Extension Builder. To show Develop menu go to Safari -> Preferences -> Advanced. Change extension metadata as required from the Extension Builder. To package the extension for distribution, get an extension certificate from Apple.

Testing

  • run npm test to run unit tests.
  • run npm eetest to run all E2E tests.
  • run npm-nonci to run E2E tests for websites which blocks bot or where the extension is not functional
  • run npm eetest-ci to run E2E tests where extensions and tests are working as expected

Licenses

  • GNU-GPL-3.0

  • CC-By-NC-ND License

Contributions

If you would like to contribute to the development of this extension, please contact the developers.

  • Google Summer of Code grants are available every year. If you would like to apply, it is never too early to contact us.