Tron

Description/Goal

Consolidates chart and metrics to be displayed in a modular fashion.

Prerequisites

• Node.js >= 4.0.0 (for ES2015 support)
• Python 2.7.x (Documentation)

Usage

Install

npm install

Config

Copy and rename settings/server-default.json to settings/server.json. Provide necessary config for remote endpoint(s) in settings/server.json. You can provide multiple remotes.

"remotes": [{
    "path": "/forecast/:id", // path on application
    "controller": "videohub", // request and response handler
    "url": "path/to/api", // remote url to send request
    "auth": {
        "user": "[email protected]",
        "password": "password"
    },
    "header": {
        "Accept": "application/json"
        "X-VHS-networkId": 1234
    }
}],

Starting local server

npm start

* Links below only work when local server is running

Documentation

Generate documentation

npm run doc

View documentation

• Index *
• Models *
• Views *
• Interface *
• Helpers *

Examples

• Interactive Demo *
• Documentation of examples on Interactive Demo *

Test Coverage

Generate report

npm run test-coverage

Viewing the report

• Test Coverage Report *

Development

Build all assets

npm run build

Build only javascript

npm run browserify

Build only css styles

npm run less

Contributors

Remember to do the following when publishing:

Document it

• Update CHANGELOG
• Update README if necessary
• Update version number in package.json according to semver

Test it

npm run test

Build it

npm run build

Publish it

npm publish