@fabernovel/heart-dareboost v3.3.0

Heart Dareboost

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

Read more about the purpose, design and general installation of Heart.

Package manager

In the following sections, every examples are using NPM as package manager, but you can use any other you prefer: Yarn, pnpm...

Installation

1. Add the package to your project:

   npm install @fabernovel/heart-dareboost

2. Add Heart CLI if you have not already installed it

   npm install @fabernovel/heart-cli

3. In the project root folder, create a .env file with the Dareboost API token:

   DAREBOOST_API_TOKEN=My_Dareboost_Api_Token

Usage

Analysis setup

The analysis setup must use the JSON format, and follow the request format API documentation, except the token property, that you set up during the installation.

Example

Starting with this situation:

Using Heart CLI

You want to analyse the https://heart.fabernovel.com URL and check that the rating is at least 90

npx heart dareboost --inline '{"url":"https://heart.fabernovel.com","location":"Paris"}' --threshold 90