Boilerplate built on Node.js, Restify, CoffeeScript for building APIs
Install packages as the following:
$ npm install -g coffee-script coffeelint mocha
The global configuration file is located in ./config/global.yaml
The defaults should be sufficient in any developer environment, however you may want to change the parameters in production environments.
The current variables are also for configuration besides the global configuration file
PORT
(optional): TCP port where the API will listen (default: 5000)
The API can be started with the following:
$ npm start
Run unit and end-to-end tests with the following:
$ npm test
The boilerplate can be compiled into pure JavaScript with the following command:
$ npm run build
This will compile CoffeeScript to JavaScript into the lib/
directory
Blueprint is available on Apiary
The documentation is rendered from the apiary.apib
file from this repository
This boilerplate application is running on Heroku
$ curl http://node-restify-coffee.gaborszathmari.me
{"message":"Hello World!"}
Pull requests are welcome
Check CONTRIBUTE.md for more details
This project was inspired by the following boilerplates:
The project was first featured on the Rainbow and Unicorn security blog
See the LICENSE file for license rights and limitations (MIT)