lexa044/restify-base

Boilerplate setup for building a Node.js RESTful API server with restify

restify-base

Boilerplate setup for building a Node.js RESTful API server with restify.

Included

This project will set up the basic structure for restify including setting up a YAML configuration file, logging with bunyan, and testing with mocha and supertest. The server will spawn a worker for each CPU using node's cluster module.

Usage

package.json is set up to use forever to manage processes, so npm start and npm stop will run forever to start the server.js script. npm run-script list will list out the forever processes that are running.

1. Customize the package.json file with appropriate name, version, and dependency versions.
2. Install dependencies: npm install -d
3. Run it: npm start

Testing

There is an example of testing the example route in the test directory. Run all test specifications with mocha using: npm test