Mixtape

Getting Started

Track list:

• Locomotive
• Express
• Angular
• karma
• Jasmine
• chai
• sinon
• Bootstrap
• Redis
• MongoDB
• Less
• Jade

This mixtape is heavily influenced by these projects

• Backbone Boilerplate
• angular-app
• ng-boilerplate
• Angular Fun
• angular-requirejs-seed
• Grails

Global Dependencies:

• Node
• Mongo
• Redis
• Grunt npm install -g grunt-cli
• Bower npm install -g bower
• Nodemon npm install -g nodemon
• Docco npm install -g docco

Starting:

Install the Node dependencies locally.

npm install

Install the client dependencies.

bower install

Start your Mongo DB instance (if it's not already)

These are the Grunt.js tasks that are available:

• clean Removes the 'dist' and 'test-reports' directories so that nothing lingers from previous builds.
• jshint Runs the JavaScript through JSHint to check for errors.
• concat Combines the almond require shim with the application code.
• cssmin Concatenates and minifies the project's CSS into one file.
• uglify Takes the built and optimized require.js file and minifies it for filesize benefits.
• runapp This will start a Node.js Express server application on a specified port and serve up the application files from various project directories.
• runapp:development Uses port 3000 to serve the JavaScript files directly from the app/ directory. Serves the compiled style.css contained in 'dist/assets/css' directory.
• runapp:debug Uses port 3003 to serve the 'human readable' concatenated JavaScript files and compiled CSS.
• runapp:production Uses port 3033 to serve the concatenated and minified JavaScript and the compiled CSS.
• less Compiles the Less files into usable CSS.
• copy Packages up the compiled code and static resources into a deployable directory structure.
• copy:release Packages up the minified JavaScript code.
• copy:debug Packages up the readable JavaScript code.
• docco Iterates throught the source files and creates annotated source code.
• jade Uses grunt-contrib-jade to compile the jade templates.
• jade:templates Compiles the client jade templates into html.
• jade:debug Compiles the index.html for the debug package.
• jade:release Compiles the index.html for the release package.
• karma Kicks off the spectacular Karma test runner.

And a couple of shortcut tasks to run various combinations:

• grunt debug

  • Cleans the project
  • Runs the application JavaScript through JSHint.
  • Compiles the Less into CSS
  • Compiles the JavaScript via RequireJS Optimizer.
  • Minifies the CSS.
  • Compiles the jade templates

• grunt assemble

  • Does everything in the 'debug' task
  • Concatenates the compiled JS with Almond.js
  • Assembles and packages the application.

• grunt test

  • Does everything in the 'assemble' task
  • Forks the current process and starts the application server (for e2e testing)
  • Runs the karma unit tests karma:unitci
  • Runs the karma e2e tests karma:e2eci
  • On completion, the forked node server shuts down