Installation

Previous: Home

Pre-requisites

• Node.js
• Grunt
• Ruby (if using SCSS/Compass)
  • Ruby and SCSS/Compass are required for the demo application in this repository

Installation

Installation should be pretty straightforward, assuming the pre-requisites have been installed:

1. Clone this project into the directory of your choosing.
2. On the command line, cd into this directory.
3. Run npm install. This will install all node.js dependencies.
4. Run grunt. This will run a build and create a /dist and /docs directory.

Development should be done within the /src directory. /dist is your production directory and can be deployed in whatever way you choose.

The term 'root' when used in this documentation will refer to your application root: either /src or /dist, depending on environment.

Next: Developer Guide