NPM Boilerplate Node
Boilerplate for creating an NPM module for Node environment.
Installation
$ npm install npm-boilerplate-node
Usage
const foo = ; async { const result = ; console;};
API
Parameters
bar
(String
): Requires string.baz
(optionalObject
): Optional object, default to{}
.
Returns
It returns a Promise
which when resolved contains something.
Related
- npm-boilerplate-node-browser: Boilerplate for creating an NPM module both for Node and browser environments.
License
Using the Boilerplate
Download the boilerpate:
wget https://github.com/risan/npm-boilerplate-node/archive/master.zip \ -O master.zip && \ unzip master.zip && \ mv npm-boilerplate-node-master my-package && \ rm master.zip
Toolings:
Available scripts:
npm run lint
: Run the linter.npm run lint-fix
: Apply the linter fixes.npm run test
: Run the tests.
Third-party services:
- Travis CI for continous integration.
- Codecov for test coverage report.
- Greenkeeper for automated dependency management.