@fabernovel/heart-greenit

Description

Heart GreenIT is an analysis module of Heart, which analyses URLs with GreenIT.

Read more about the description and design of Heart.

Usage

Standalone

1. Install the package

   npm install @fabernovel/heart-greenit
   

   If you are using Yarn, npm < 7 or PNPM < 8, you also have to install Heart CLI (which is automatically installed in more recent versions of these packages managers):

   npm install @fabernovel/heart-cli
   

2. Start an analysis

   npx heart greenit --config '{"url":"https://www.fabernovel.com/"}'
   

   OR

   npx heart greenit --config config.json
   

   The analysis configuration follows the JSON format and has the following keys:

   {
       "url": "https://www.fabernovel.com/",
       // optional - default: 3000
       "timeout": 1000,
       // optional - default: 2
       "retry": 2,
       // optional - default: "desktop"
       // possible values: "desktop", "galaxyS9", "galaxyS20", "iPhone8", "iPhone8Plus", "iPhoneX", "iPad"
       "device": "galaxyS20"
   }
   

Github Action

If you're using Github, you can simplify the integration of Heart in your CI scripts by using the Github Action.

Disclaimer

The LCA values used by GreenIT to evaluate environmental impacts are not under free license - © Frédéric Bordage

Please also refer to the mentions provided in the code files for specifics on the IP regime.