https://github.com/les-enovateurs/estimate-good-website

https://github.com/les-enovateurs/estimate-good-website

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/les-enovateurs/estimate-good-website
• Owner: les-enovateurs
• License: mit
• Created: 2022-06-16T11:27:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T10:06:37.000Z (12 months ago)
• Last Synced: 2024-06-14T11:29:33.946Z (12 months ago)
• Language: JavaScript
• Size: 116 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EcoSurf Analyser

Description: Mozilla Extension to display on the navbar the ecoIndex score of the page.

The extension call the ecoIndex Api to get the score displayed on the nav bar. 

More information about the EcoIndex API [here](https://github.com/cnumr/ecoindex_api)

## Installation 

### On your browser

- Firefox : [here](https://addons.mozilla.org/firefox/addon/ecosurf-analyser/)

- Chrome : [here](https://chromewebstore.google.com/detail/ecosurf-analyser/ikhjihalbdlnjacdnonecbddejboajkl)

### Install locally

- download the repository

- open your browser and go to `about:debugging#/runtime/this-firefox`

- click on button : `load temporary extension firefox`

- select the manifest.json located in the EcoSurfAnalyser folder

## How it works

On each website the user goes. The extension get the url and ask ecoIndex API if an analysis has been made recently.

- If so the extention return the score from `A` to `G` visible on the navbar. `A` meaning a small carbon foodprint impact and `G` a significant carbon foodprint.

- If no data were collected, the extension ask EcoIndex API to measure the website. Following an heuristic strategy, EcoSurf Analyser will try again to contact the server to fetch data based on the original url. 

## Dependencies

As mention above, [the EcoIndex API](https://github.com/cnumr/ecoindex_api)

## Contribute

If you found a bug, please open a [issue](https://github.com/les-enovateurs/estimate-good-website/issues) (please search first if the bug is already mention on an existing issue).

Feel free to contribute by creating a [pull request](https://github.com/les-enovateurs/estimate-good-website/pulls)