Skip to content

elos/horizon

Repository files navigation

Horizon

Horizon is the elos web application. It is based on Corey Prophitt's simple app structure for building AngularJS apps. This project includes a lot of basic configuration and Gulp tasks for linting JS and SCSS as well as building/watching code.

Requirements

  1. You should have ruby with bundler
  2. You should have npm

If you receive a 'bundle' command not found, you can install bundler via:

gem install bundler

Note, OSX users may have to use sudo while installing bundler.

Quick Start

  1. Clone the repository and change into the repository directory
  2. Install ruby gems with bundle install
  3. Install the node requirements: npm install
  4. Install the Bower components: ./node_modules/.bin/bower install
  5. Run locally: ./node_modules/.bin/gulp or create a build: ./node_modules/.bin/gulp build

Alternatively, you can run:

  1. npm run watch for development
  2. npm run build for a production build

NPM Notes

These notes only apply if you use gulp or bower.

It's easier to use local node modules if you append it to your PATH:

export PATH=node_modules/.bin:$PATH

After adding the local path to your PATH variable, you must source your .bashrc file.

source ~/.bashrc

Then you can use all node modules local to the repository without prepending the long file path or installing gulp or bower as a global binary.

Running Unit Tests

You can run the unit test suite via npm:

npm test

In addition to running the test suite, the code is checked with jshint for any errors. The test suite will fail if any jshint errors are found.

Releases

No releases published

Packages

No packages published