⚡ Simple framework for easily creating dashboards to display metrics ⚡
Clone or download
dannycroft Minor refactoring
- Reduce progress widget render fn line size
- Reduce job start fn line size
- Add missing cross-env to second npm prod argument
Latest commit 75327ff May 12, 2018

README.md

Build Status Maintainability Support Docs

Metricio

Metricio (🔊) is a dashboard framework that helps you display metrics and monitor systems and APIs.

Simple to get started and quick to create build screens for all your teams.

Metricio has a similar design and architecture to Dashing, which used to be my "goto" framework for dashboards. Unfortunately, Dashing is no longer maintained. However, if you have a preference to writing CoffeeScript and Ruby then that framework is still awesome!

Metricio allows you to:

  • Build widgets with React components
  • Create jobs with Node.js and async/await
  • Support for multiple dashboards
  • CRON like scheduling with node-scheduler
  • Caching handled with Redis
  • Event-based communication with socket.io
  • Number formatting with Numeral

The UI aims to use a little resource as possible. Enabling your dashboards to run without crashing for prolonged lengths of time on even the most neglected Raspberry Pi.

See the Docs for requirements, setup and customisation.

Example

Install

npm install

Start - Develop

npm run start

Test

npm run test

Start - Production

npm run production

Lint Project

npm run lint

Contributing

Any help is welcomed and appreciated.

License

Distributed under the MIT license