Skip to content
James Errington edited this page Jun 22, 2017 · 1 revision

Grunt

grunt.js is used to build releases and to install rg2 on the routegadget.co.uk sites. It would make sense to install node.js first so that you can install things via npm. Then install Grunt.

npm install

Run npm install from a shell in the top-level directory. This should install all the necessary packages to allow you to build rg2.

Gruntfile.js

Grunt tasks are defined in Gruntfile.js in the top-level directory. If you look at the end of the file you will find the various tasks required to build rg2. The earlier part of the file defines and configures the various tasks.

grunt build (the default grunt task)

Runs csshint, jslint and jshint to find code problems. Then generates minified css and js files, plus the associated maps for debugging. The end result is rg2-x.y.z.min.js, rg2manager-x.y.z.min.js and rg2-x.y.x.min.css which are the core files loaded by index.php.

grunt bump

Used to increment the version number in package.json (or this can be done manually). Only really relevant when building a new release for the master branch. This version number is reported on the information dialog.

grunt deploy

Used to create a formal release (for Github) and to copy the relevant to temporary release directories locally for upload to the routegadget.co.uk site.