Efemetrics NPM

About The Project

The main purpose of the project was to find a solution to reporting metrics and events from a web application. To achieve that, we have created a library. Its basic functionality is sending metrics. Each metric has a separate field indicating the creating time, value and tag list. Sending the metric can be initiated by event such as click on button or run completely in the background.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is a list of things you need to run the project locally and how to install them.

npm
```
npm install npm@latest -g
```

docker

 $ sudo apt-get install docker-ce docker-ce-cli containerd.io

Installation

Clone the repo

git clone https://github.com/nokia-wroclaw/innovativeproject-fe-metrics.git

Go to front folder
```
cd frontend/root/efemetric/
```
Install NPM packages
```
npm install
```
Build front
```
npm run build
```
Go to root folder
```
cd ../../..
```
Build docker
```
docker-compose up -d --build
```
Stop docker
```
 docker-compose down
```

Usage

You can test our library on the demo page at the app demo page. We have also created example dashboards in grafana that will allow you to visualize the data sent. If you want to test locally, do not change the data in the database connection form

For more examples, please refer to the Documentation

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.