Getting Started

Being a JavaScript project we like to use JavaScript in our tool chain wherever possible. We use Node.js and Grunt CLI to help automate tasks.

To setup HelixJS do the following:

Setup using Chocolatey (Windows)

Use the Windows package manager Chocolatey to make installation process less painful.

  • Clone HelixJS in GitHub.
  • Navigate to your cloned HelixJS folder and then to the setup folder.
  • Run each batch file in numerical order.

Note: Sometimes you may need to close all Windows Explorer and Command Prompt windows in order to get the PATH to update to reference Node.js.

Manual setup (Windows and Non-Windows)

  • Clone HelixJS in GitHub.
  • Install Node.js v0.8 or higher.
  • Make sure Node.js is accessible from your CLI. On Windows make sure the Node.js folder is added to your PATH.
  • Navigate to your cloned HelixJS folder and then to the setup folder.
  • Using your CLI, install package dependencies using npm:
npm install
npm install grunt-cli -g

Running the Test Suite

HelixJS is tested using Jasmine. To run the specs navigate to the HelixJS folder using your CLI and enter:

grunt
start http://localhost:9001/spec/runner.html

If you are using Windows you can do the following from Windows Explorer:

watch.bat
specs-in-browser.bat

Everything should hopefully go green!