Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 1.63 KB

README.md

File metadata and controls

76 lines (52 loc) · 1.63 KB

Banner

vidi-metrics-web

A web interface for capturing vidi metrics - where users can submit data in JSON file format. This JSON object via UDP emitter goes to InfluxDB that will connect with Graphing instance which will graph data from JSON object.

  • Work in progress This module is currently a work in progress.

Install

To install the app locally, simply clone the repo,

git clone https://github.com/vidi-insights/vidi-metrics-web
cd vidi-metrics-web

Next, install and build via npm,

npm install

Running

To build app run:

npm run build

To start server run:

npm run start

Which will start on port 3010.

Also you can watch the files for changes and automatically rebuild the sources running this command in a different terminal window:

npm run watch

Receiver

To run a dummy receiver, open a second console window and run :

npm run receiver

This will echo any metrics sent via the vidi-metrics-web.

Contributing

The nearForm encourages open and safe participation.

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

License

Copyright (c) 2016, Kristina Matuleviciute and other contributors. Licensed under MIT.