rdm-app

This is the codebase for the rdm.openlighting.org website.

If you're intested in how PID definitions work, see https://wiki.openlighting.org/index.php/RDM_PID_Definitions

Get dependencies

Before you upload to appengine or start developing you'll have to download some javascript dependencies. These can be downloaded using nodejs's package manager npm. The packages get downloaded using bower and grunt You have to install grunt-cli globally yourself by running either

npm install -g grunt-cli

or

sudo npm install -g grunt-cli

and to install all the other dependencies of the project, run in the root directory of the project

npm install
grunt bower

Which first installs the node.js dependencies (grunt, bower, karma) and then runs the grunt task for installing the bower packages

Important!

only install bower packages through grunt, because grunt moves them to static/libs and appengine and karma both expect them to be there and not in bower_components also static/libs has a different structure then bower_components.

Run unit-tests for rdm.js

Currently only rdm.js in static/js has a javascript unit-test using karma the unit-test is located in unit-test-js/tests/rdm.js and the karma configuration in unit-test-js/karma.conf.js the test can be run by running

grunt unit-test

It does require firefox and the dependencies to be installed to be able to run the test

Compress rdm.js

The source for static/js/rdm.js is in js_src/rdm.js. however when you adjust rdm.js you have to compress it you can do this by running

grunt compress

or if you are continuously adjusting the source and testing it, and you just want to automate the compressing of rdm.js run

grunt compress-watch

Debug rdm.js

If you are having trouble with debugging the minified source of rdm.js you can copy the files to the static dir using

grunt copy-once

or if you want an automatic copy run

grunt copy-watch

Important!

When you are done debugging don't forget to run

grunt copy-cleanup

otherwise the files won't be compressed