README.md

Quickstart RESTful node.js application

Commands

Development

During development it is recommended to start two terminals with following commands:

• grunt dev - start nodemon with debugger. Debugger is available on: http://localhost:1337/debug?port=5858
• grunt watch - runs jshint and unit tests on every file change

Production

On production environment start application with supervisor:

• npm start - same as supervisor app/start.js

Switching environments

In order to change application environment use:

• Windows:

    set NODE_ENV=production
    supervisor app/start.js
  

• Unix/Linux:

    NODE_ENV=production supervisor app/start.js
  

Functionalities

• Everything what is needed for advanced rest api: routing, content negotiation, error handling, versioning.
• Configuration per environment
• Logger per environemnt
• Unit tests
• Integration tests

Dependencies

Runtime modules:

• Express - web framework
• Bunyan - logger
• Lo-Dash - utility library

Testing modules:

• Mocha - test framework
• Chai - assertion mechanisms
• Sinon - mocking framework
• Blanket - code coverage
• Supertest - HTTP assertions designed for express - useful for integration tests