Environment Features

• Linting/Code Style
  • IDE
    • .editorconfig
    • Sublime Text Plugin
  • Javascript
    • .eslintrc
    • Submlime Text Plugin
• Karma + Jasmine
• gulp
• Bower
• SASS
• ECMAScript 6 - Babble
  • Any files with the name ending in *.es6.js will be translated to es5 during build
• RequireJS
  • Assumption: Any Javascript in the /modules folder will be loaded by RequireJS
  • Karma/Jasmin is configured to test Javascript in the /modules folder as RequireJS modules

Features Wish List

• PostCSS
  • Consider: Replace SASS (libsass) for a performance increase.
• Webpack
• Bower Shrinkwrap/Lock File
• Yeoman generator
  • Default templates
    • AMD module
    • Component
    • Angular (module, service, directive, etc)
    • React components
    • (All) With tests
  • Dev notes:
    • npm install -g generator-generator
    • npm link

Install Instructions

First time setup

1. Install Node.js/npm by downloading at nodejs.org

2. Install bower globally

   npm install bower -g

3. To make gulp commands easier, install the gulp package globally

   npm install gulp -g

Every Time Setup

1. Grab a copy of the project from GitHub.

   git clone https://github.com/keobrien/Railay.git

2. Install Node dependancies

   npm install

3. Install Bower dependancies

   bower install

Run

Dev mode

1. gulp serve-dev
2. Go to localhost:3000

Test mode and watch files to run tests/linting

1. gulp serve-test
2. Go to localhost:3000

Compiled mode

1. gulp serve-dist
2. Go to localhost:3000