Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jzillmann/dashgen
Generates a static HTML report out of generic JSON files
https://github.com/jzillmann/dashgen
dashboard generator html-report
Last synced: 11 days ago
JSON representation
Generates a static HTML report out of generic JSON files
- Host: GitHub
- URL: https://github.com/jzillmann/dashgen
- Owner: jzillmann
- License: mit
- Created: 2019-11-14T16:00:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T00:03:28.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T11:02:32.917Z (18 days ago)
- Topics: dashboard, generator, html-report
- Language: HTML
- Homepage: https://jzillmann.github.io/dashgen/
- Size: 199 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dashgen
Simplistic _static_ dashboard generator. Store your metrics in a generic JSON format, _Dashgen_ will generate an HTML report out of them them!
[Demo](https://jzillmann.github.io/dashgen/)
## 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 `
- Open `/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`