Marionette HTML Application Foundation

Features

• Module Styles
  • SCSS
  • Compass
• Application
  • RequireJS
  • Marionette
  • Backbone
  • Handlebars
  • Underscore
• Unit Testing
  • Jasmine
  • Jasmine jQuery
• Karma

Requirements

• Homebrew OSX Only
• NodeJs
• RequireJS
• Compass

Installing NodeJS (OSX)

Note: Both the package and Homebrew install of NodeJS come bundled with npm.

Installing NodeJS through the standard package install requires root privileges; which may cause permission issues down the line. We recommend you install NodeJS through Homebrew:

# If you've previously (or have currently) installed node,
# skip this and see next section!
brew update
brew install node

Homebrew does not require root privileges and installs (typically) into /usr/local/bin.

Uninstall a Node Pkg Install (OSX)

I've you've previously uninstalled NodeJS through the package installer; it's important to uninstall the old version before proceeding with a Homebrew install.

Follow these steps to remove NodeJS from your system:

1. Remove any files / folders named node, node_modules, .npm from:

   • /usr/local/lib
   • /usr/local/include
   • /usr/local/bin
   • /usr/local/share/man/man1/
   • /usr/local/lib/dtrace/
   • /Users/USERNAME/

2. Now correct (probably clobbered) permissions:

   • sudo chown -R `whoami` /usr/local/lib/

After this is complete run:

brew update
brew doctor

Follow any instructions it gives you before proceeding.

Finally:

brew install node

Install Required Packages

Note: Depending on your setup, sudo may be required.

gem install --no-ri --no-rdoc compass
npm install -g requirejs

Testing Requirements:

• Karma
• Jasmine
• RequireJS
• Jasmine-jQuery

Ensure that you have installed karma CLI

npm install -g karma-cli
npm install

To install testing dependencies:

You must have installed node.js and npm for this to work, see above. Run this from your shell:

make install-test-reqs

To continuously run your tests:

./node_modules/karma/bin/karma start

That's horrible, so lets simplify that:

NOTE: You will only need to make install-test-cli once, no matter the project. Karma installs as a shortcut globally on your system.

If you already have the karam cli tool installed, running this command may simply generate an error. Do not panic. Nothing is broken.

make install-test-cli

Now to run your tests, from the root of your project run:

karma start

Quick Start Commands

To get started you'll only need to run make serve and make watch.

# start a dev server
make serve

# run compass watch
make watch

# build project
make all

Want docs? ok...

npm install
pip install sphinx sphinx_rtd_theme
make doc
make serve-doc

view local docs