@ebury/huha

HUHA

This repository contains the source code for HUHA (Hyperactive Users Hint Analysis).

HUHA is a JavaScript library that helps measure the usability and user experience of a project in an automated way.

1. Vision
2. Code Owners
3. Contributing
4. Installation
5. Usage
6. Prerequisites
7. References

Installation

If you want to contribute to the library then you will have to clone the repository and install all dependencies:

git clone https://github.com/Ebury/huha.git
cd huha
npm install

Usage

If you want to use the library in your project then you will have to install it (via npm) as a dependency:

npm install @ebury/huha --save

And then you can import the Huha class in your application:

import Huha from '@ebury/huha'

API Reference

You can visit Reference to check the reference.

Prerequisites

For the correct registration of the information in the tracking tools it is required that the set-up scripts of those tools to be used have been executed, which will define the necessary global variables. For instance, if the option trackOnSegment is set to true, HUHA expects to find the Segment corresponding global variable, analytics, filled in.

References

JavaScript

Jest

npm

Google Analytics

Intercom

Segment