Hyperkiosk - easily create dashboard web apps
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
src
.coveralls.yml
.editorconfig
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

hyperkiosk

npm version Build Status Coverage Status Downloads License

Hyperkiosk - easily create dashboard web apps. Please see hyperkiosk-demo for a demo project using hyperkiosk.

Installation

You can install hyperkiosk globally with npm i -g hyperkiosk, but preferred way is like in the demo locally: npm i --save hyperkiosk

Usage

Usage: hyperkiosk [options]

Options:
  --version      Show version number                              [boolean]
  --port, -p     Set the server HTTP port          [number] [default: 3000]
  --config, -c   Set config file path                    [string] [default:
  "$PWD/hyperkiosk.js"
                                                                          ]
  --verbose, -v  Increase verbosity                                 [count]
  --help, -h     Show help                                        [boolean]

Development

You need a hyperkiosk config file, see hyperkiosk-demo

API

  • hyperkiosk(id: string): Creates a dashboard with the given id.
    • gen(id: string, emitter: Function, interval: number): Creates a widget with the given id, an emitter function, which is called at the given interval.
    • get(id: string, url: string, interval: number, requestConfig: Object): Creates a widget with the given id, an URL, which is called with requestConfig at the given interval.
    • push(id: string, value: any): Creates a widget with the given id and an value, subsequent calls with same id update the value

License

The MIT License