Development
A reference app that uses this package is available here;
Starting development
To build the code there are a few requirements
- Node.js -- We use Node for build and test automation. Download and install Node.js
- grunt-cli
Unix-based systems
sudo npm install -g grunt-cli
Windows
npm install -g grunt-cli
to setup your project, position your current directory inside the sdk folder and run:
npm install
Grunt commands
Some grunt tasks are available:
grunt
grunt dev
Builds the reference and demo player.
grunt dist
Builds the code and and places the final app in dist
folder.
grunt deploy
An example on how to use ftp to send the app to a webserver.
If the ftp server requires authentication, credentials should be placed in a file .ftppass in the root of the project
About the code
Javascript are written using the ES6 standard. Using grunt tasks this is then re-written to the ES5 standard where available. To learn more about Es6 see babel.
To keep our code clean and separated, we uses Browserify. This allows us to use require statements to import javascript code from other files.
All of the above is done automatically using the grunt build system, but during development one should be aware of the power, and the limitations of both systems.