npm-node-boilerplate

Boilerplate for nodejs npm package

Tech-Stack

• nodemon development mode
• jest test environment
• jsdoc documentation
• npm-check for dependencies check
• pre-commit for pre git commit hooks
• babel to compile to es2015
• travis-ci
• node-config

Scripts

# start development mode with nodemon
yarn dev
# run tests with jest
yarn test
# start continous integration testing with jest
yarn ci
# generate the jsdoc documentation
yarn jsdoc
# run eslint
yarn lint
# check for dependendies updates
yarn deps
# build with babel
yarn build

Usage

1. Clone the repository and init new git project

$ git clone git@github.com:mbaertschi/npm-node-boilerplate.git ./your/project/folder
$ cd ./your/project/folder
$ rm -rf .git
$ git init

1. Change project specific information in the following places

• .github/CHANGELOG.md
• package.json
• README.md

1. Install and update dependencies

$ yarn install
$ yarn deps # run updates if available

1. Run tests

$ yarn test

1. Start coding