Dashgen

Simplistic static dashboard generator. Store your metrics in a generic JSON format, Dashgen will generate an HTML report out of them them!

Demo

Usage

JSON report structure

Have one or multiple files in this JSON format:

{
    "sourceName": "my source"
    "reports": [
        {
            "name": "my report 1",
            "metrics": {
                "key1": "value1",
                "key2": "value2",
                ...
            },
            "messages" :[
                "Something seemed slightly off with ..."
            ]
        },
        {
            "name": "my report 1",
            ...
    ]
}

Generate a dashgen report

• npm install --global dashgen
• dashgen <dataFolder> <targetFolder>
• Open <targetFolder>/index.html

Development

How to build

• npm run dev => Serve the svelte app over HTTP with live reload. Visit http://localhost:5000.

How to publish

• Test the package with npm run pack:dry and npm run pack
• Test cli.js with npm link. Now you can execute dashgen. Unlink with npm unlink.
• Release the package:
  • npm version [patch|minor|major]
  • npm release