Installation

Previous: Home

Install Prerequisites

• Install Node.js.
• Install Grunt. $ npm install -g grunt-cli

If you intend to run the demonstration application in this repository, you will need Ruby and SCSS/Compass

• Install Ruby. (required for compass/sass)

• Install Compass (used for CSS authoring).

  $ gem install compass

Build

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

• Download or clone the Keel repository into the directory of your choosing.

• Open a command shell and cd into this directory.

• Install all node.js dependencies:

  $ npm install

• Execute the following command to build the demo application. This will run a build and create a /dist and /docs directory:

  $ grunt

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