Have ideas to improve npm?Join in the discussion! »

@fabernovel/heart-dareboostTypeScript icon, indicating that this package has built-in type declarations

3.2.1 • Public • Published

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

Using Heart CLI, starting a Dareboost analysis of https://heart.fabernovel.com could look like that:

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

Keywords

none

Install

npm i @fabernovel/heart-dareboost

DownloadsWeekly Downloads

4

Version

3.2.1

License

MIT

Unpacked Size

19.7 kB

Total Files

20

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar