# npm-node-boilerplate

> nodejs npm package boilerplate

Latest version **1.0.3** (published 2018-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-node-boilerplate
pnpm add npm-node-boilerplate
yarn add npm-node-boilerplate
bun add npm-node-boilerplate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-06-11 |
| First published | 2018-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.9.x |
| Dependencies | 1 |
| Unpacked size | 650.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Bärtschi |
| Maintainers | mike89 |
| Keywords | nodejs, npm, boilerplate |

## Links

- npm: https://www.npmjs.com/package/npm-node-boilerplate
- Repository: https://github.com/mbaertschi/npm-node-boilerplate
- Homepage: https://github.com/mbaertschi/npm-node-boilerplate#readme
- Issues: https://github.com/mbaertschi/npm-node-boilerplate/issues
- npm.io page: https://npm.io/package/npm-node-boilerplate

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^3.1.0

## Recent versions

- 1.0.3 (latest) — 2018-06-11
- 1.0.2 — 2018-03-26
- 1.0.1 — 2018-03-22
- 1.0.0 — 2018-03-15

## README

# Boilerplate for nodejs npm package
<!-- Build Status -->
<a href="https://travis-ci.org/mbaertschi/npm-node-boilerplate">
  <img src="https://travis-ci.org/mbaertschi/npm-node-boilerplate.svg?branch=master">
</a>
<!-- Dependency Status -->
<a href="https://david-dm.org/mbaertschi/npm-node-boilerplate">
  <img src="https://david-dm.org/mbaertschi/npm-node-boilerplate.svg" alt="Dependency Status" />
</a>
<!-- devDependency Status -->
<a href="https://david-dm.org/mbaertschi/npm-node-boilerplate?type=dev">
  <img src="https://david-dm.org/mbaertschi/npm-node-boilerplate/dev-status.svg" alt="devDependency Status" />
</a>

## Tech-Stack
- [nodemon](https://github.com/remy/nodemon) development mode
- [jest](https://facebook.github.io/jest/) test environment
- [jsdoc](http://usejsdoc.org/) documentation
- [npm-check](https://www.npmjs.com/package/npm-check) for dependencies check
- [pre-commit](https://www.npmjs.com/package/pre-commit) for pre git commit hooks
- [babel](https://babeljs.io/) to compile to es2015
- [travis-ci](https://travis-ci.org/)
- [node-config](https://github.com/lorenwest/node-config)

## Scripts
```bash
# 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
```bash
$ git clone git@github.com:mbaertschi/npm-node-boilerplate.git ./your/project/folder
$ cd ./your/project/folder
$ rm -rf .git
$ git init
```
2. Change project specific information in the following places
  - [.github/CHANGELOG.md](./.github/CHANGELOG.md)
  - [package.json](./package.json)
  - [README.md](./README.md)
3. Install and update dependencies
```bash
$ yarn install
$ yarn deps # run updates if available
```
4. Run tests
```bash
$ yarn test
```
5. Start coding

---
_Source: https://npm.io/package/npm-node-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._