@fabernovel/heart-mysql

Heart MySQL

Heart MySQL is a listener module of Heart, which reacts to the end of an analysis and stores the results of an analysis in a MySQL database.

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 and an analysis module, for example Heart GreenIT

   npm install @fabernovel/heart-greenit @fabernovel/heart-mysql

   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. In the project root folder, create a .env file with the database connection information set as a URL

   HEART_MYSQL_DATABASE_URL=mysql://login:password@127.0.0.1:3306

3. Start an analysis

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

   OR

   npx heart greenit --config config.json

   Once the analysis is done, the results are stored in your MySQL database.

Github Action

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