NPM version Build Status Coverage Status

NodeJS module generator/boilerplate.



The easiest way to use nod is through the Yeoman Generator.

$ npm install -g yo generator-nod
$ yo nod

If you don’t want to use the generator, you can also download or git clone this repo

$ git clone my-module
$ cd my-module
$ rm -rf .git
$ npm install # or yarn

Just make sure to edit package.json, and LICENSE files accordingly with your module’s info.


$ npm test # run tests with Jest
$ npm run coverage # run tests with coverage and open it on browser
$ npm run lint # lint code
$ npm run docs # generate docs
$ npm run build # generate docs and transpile code
$ npm run build:watch # watch code changes and run build script
$ npm run patch # bump patch version and publish to npm e.g. 0.0.1
$ npm run minor # bump minor version and publish to npm e.g. 0.1.0
$ npm run major # bump major version and publish to npm e.g. 1.0.0



This function says hello.


Returns string The hello.


MIT © Diego Haz