@fabernovel/heart-bigquery

Description

Heart BigQuery is a listener module of Heart, which reacts at the end of an analysis by storing the results into a table of a Google BigQuery instance.

Note that you must install an analysis module too, to have a minimum viable installation of Heart.

Read more about the description and design of Heart.

Usage

Standalone

1. Install the package, Heart CLI and an analysis module, for example Heart GreenIT

   npm install @fabernovel/heart-cli @fabernovel/heart-bigquery @fabernovel/heart-greenit
   

2. In the project root folder, create a .env file with the Google Service accounts credentials (you can use Code Beautify to remove whitespaces)

   HEART_BIGQUERY_GOOGLE_APPLICATION_CREDENTIALS={"type": "service_account","project_id": "","private_key_id": "","private_key": "","client_email": "","client_id": "","auth_uri": "","token_uri": "","auth_provider_x509_cert_url": "","client_x509_cert_url": ""}
   

3. Start an analysis

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

   OR

   npx heart greenit --file configuration.json
   

   Once the analysis is done, the heart table of the analysis dataset is populated with the results.

Github Action

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