Boilerplate for your brand new Node.js module - NPM ready

A small boilerplate to help you kickstart your Node.js module projects with unit tests, integration tests, code coverage, continous integration, code hinting and code style enforcement.

I've also made everything ready for you so it's easy to publish your new module to the npmjs.com server.

Helper modules in use:

JSHint A tool that helps to detect errors and potential problems in your JavaScript code.

Grunt The Javascript task runner. In one word: automation. The less work you have to do when performing repetitive tasks like minification, compilation, unit testing, linting, etc, the easier your job becomes.

Buster.js A browser JavaScript testing toolkit. It does browser testing with browser automation (think JsTestDriver), QUnit style static HTML page testing, testing in headless browsers (PhantomJS, jsdom), and more.

JSCS JSCS is a code style linter for programmatically enforcing your style guide.

Istanbul A Javascript code coverage tool written in JS.

Travis Travis CI is a hosted continuous integration service. It is integrated with GitHub and offers first class support for many languages.

Coveralls.io Coveralls is a web service to help you track your code coverage over time, and ensure that all your new code is fully covered.

Retire Scanner detecting the use of JavaScript libraries with known vulnerabilities.

Howto to get started

$ git clone [email protected]:5orenso/node-simple-boilerplate.git
$ cd node-simple-boilerplate/
$ npm install
$ bash ./install.sh
# Follow the instruction.
#     Example path input: ../my-new-module

Start developing. Remember to start watching your files:

$ grunt watch

Howto check for vulnerarties in modules

# Install Node Security Platform CLI
$ npm install nsp --global  

# From inside your project directory
$ nsp check  

Howto contribute

$ git clone [email protected]:5orenso/node-simple-boilerplate.git

Do your magic and create a pull request.

Howto report issues

Use the Issue tracker

Howto update CHANGELOG.md

$ bash ./changelog.sh

Howto update NPM module

1. Bump version inside package.json
2. Push all changes to Github.

Howto upgrade modules

$ npm install -g npm-check-updates
$ ncu -u
$ npm install --save --no-optional

HOWTO upgrade dev environment

$ npm install buster --save-dev
$ npm install buster-istanbul --save-dev
$ npm install grunt --save-dev
$ npm install grunt-buster --save-dev
$ npm install grunt-contrib-jshint --save-dev
$ npm install grunt-contrib-nodeunit --save-dev
$ npm install grunt-contrib-watch --save-dev
$ npm install grunt-coveralls --save-dev
$ npm install grunt-jscs --save-dev
$ npm install grunt-nodemon --save-dev
$ npm install grunt-shell --save-dev
$ npm install grunt-jsdoc --save-dev
$ npm install grunt-retire --save-dev

Versioning

For transparency and insight into the release cycle, releases will be numbered with the follow format:

..

And constructed with the following guidelines:

• Breaking backwards compatibility bumps the major
• New additions without breaking backwards compatibility bumps the minor
• Bug fixes and misc changes bump the patch

For more information on semantic versioning, please visit http://semver.org/.

More about the author

• Twitter: @sorenso
• Instagram: @sorenso
• Facebook: @sorenso