README.md

Application - Version 0.0.1 Alpha

Installing

Prerequisites

• Install Node From website
• Install MongoDB From website
• Install Node Package Manager sudo chown -R $USER /usr/local curl http://npmjs.org/install.sh | sh

Installation

• Clone repository git clone [email protected]:Avaq/node-skeleton.git
• Install dependencies cd node-skeleton npm install
• Compile CoffeeScript cake build

Running

• Start the application. cake start or cake -w start to restart automatically on changes.

Development

Prerequisites

• Install git flow sudo apt-get install git-flow Or try: Install guide
• Initialize git flow cd node-skeleton git flow init

Coding

• Create your feature branch git flow feature start <name>
• Watch CoffeScript cake watch
• Watch JavaScript cake -w start
• Don't commit your local environment settings: How to ignore files

Testing

Write your tests in /test/<path>. The convention is to make the same as the path to the file that you're testing in /src/<path>. Generic tests may be placed in test/<name>.coffee, but should be avoided.

More about creating tests can be found in the documentation below. Tests look like this:

describe "Mocha", ->
  it "should be able to describe stuff", ->
    describe.must.exist()

Run tests using cake test or cake --watch test to continuously test.

Documentation

Application

• Lodash: Utility library used.
• CoffeeScript: Source code language.
• Node: JavaScript built-ins.
• Express: Framework used.
• Connect: Framework used by Express.
• Mongoose: Database abstraction layer used.
• MongoDB: Database used.
• Bluebird: Promise library used.
• Node Restful: Mongoose exposure to REST helpers.
• Node Logging: Logging library used.
• Node bcrypt: Hashing and cryptology library used.
• Node rand-token: Token generating library.

Testing

• Mocha: Test runner and describer
• Must: BDD asserting library.