This project is a JavaScript application for displaying data from the Performance Platform fullscreen on a large display, like maybe in building receptions and offices and teleprompters and cinemas before the films start and also turbo-trons and maybe even Google Glass where space is at a premium so you need big numbers to really get the message across.
The style was inspired by @demotive's gds-performance-slides (available on Heroku).
Firstly, it is recommended that you set up Node Version Manager on your host. See the (nvm) README for installation instructions.
Now install the specified version of node (specified in the .nvmrc file [e.g. 6.11.2]) using nvm:
nvm install 6.11.2To check you have the correct version of node installed:
nvm which
Found '/Users/<username>/<path to>/performanceplatform-big-screen-view/.nvmrc' with version <6.11.2>
/Users/<username>/.nvm/versions/node/v6.11.1/bin/nodeNow tell nvm to use the version of node specified in the .nvmrc file:
nvm useThis project uses gulp.js to build. Install it with npm install -g gulp or just run
npm install in this project and use the local version at ./node_modules/gulp/bin/gulp.js.
The app uses the Performance Platform client. Run npm install to make sure you have an up-to-date version of this repo which hasn't been touched in 2 years.
To start a development server:
gulp server
Then hit a valid dashboard URL eg. http://localhost:8080/public/performance/big-screen/carers-allowance
To run the tests:
npm test
Note
There are a set of functional tests that are intended only to be run on the continuous integration environment. They can be run locally, but the side effect is that they rewrite the root-level config.json file, so you will need to revert it after running the tests.
These tests are not run locally by default