open-index/open-npm huggingface dataset:
npm package: @ottm/survey-front-library
Description: Agnostic library used to get informations from a micro service ([survey-back-api](https://github.com/optittm/survey-back-api)) in order to determine if a modal can be shown or not. It is also used to send feedback information from the user's perspective.
Author: Benjamin BALET
Latest version: 1.2.1

# Agnostic Javascript Library

Agnostic library used to get informations from a micro service ([survey-back-api](https://github.com/optittm/survey-back-api)) in order to determine if a modal can be shown or not. It is also used to send feedback information from the user's perspective. 

## Requirements
- Nodejs with npm

## Build the library

In order to build the library, we use Babel framework. It allows us to create JS ES5 files from JS ES6 files.
First thing to do is to run these commands in the library's folder:
```
npm install
npm run build
```
It will create a dist folder where JS ES5 files will be inside.
The index.js file at the root of the project is used as an entry point of the library.
It retrieves all the functions / classes present in the dist folder to expose them to users.


## Test the library 

In order to test the library, we use the jest library, developped by Facebook. To run the UT, run the following command:
```
npm run test
```

## Usage 

In order to use the library, you juste need to import it in the way describe below:
```
import Network from '@ottm/survey-front-library';
```

**WARNING**  
This library is using [FingerprintJS](https://github.com/fingerprintjs/fingerprintjs) to generate a user ID. You should be aware of your compliance with laws such as GDPR regarding the collection and treatment of user data.  
If you are using this library with our [API](https://github.com/optittm/survey-back-api), the fingerprint usage can be disabled in the API configuration.

## Contribute

The tool is released under a MIT licence. Contributors are welcomed.
npm package: @ottm/survey-front-modal
Description: Library used to display a modal when it's necessary to get user's feedback from a specific feature
Author: Benjamin BALET
Latest version: 1.1.1

# User feedback Library

Library used to get user feedback on a specific functionality of your own site.
The feedback is given through a modal where the user is invited to give a rating and a comment on the functionality currently used.
This is part of the OTTM Survey tool ([survey-back-api](https://github.com/optittm/survey-back-api) and [survey-front-library](https://github.com/optittm/survey-front-library)).\
**We have a specific documentation to install and test this project locally : `local_installation.md`.**

## NPM installation for survey front modal

In order to install the library, you need to have npm install. Then, run the following command:

``` bash
npm install @ottm/survey-front-modal
```

## Usage 

**See examples in the folder `examples` for Angular, React and JS.**

Lexique :

- *data-api-url* : the address where to send the user's feedback (address of your survey-back-api).
- *urlFeature* : the url of the functionality (web page where the script will be inserted) you want to monitor. The library will automatically get the current page's URL, but you can optionally provide a custom one.



## Todos

- [ ] Remove the direct dependency on fingerprintjs once the library's npm package is updated.
- [ ] Give the possibility to the user to custom the modal with is own graphic chart.

## Licence

Survey front modal is available under the MIT license. See the LICENSE file for more info.