# npm-module-template

> NPM package template to quick-start with Babel, Flow, ESLint and Mocha.

Latest version **1.0.5** (published 2016-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-module-template
pnpm add npm-module-template
yarn add npm-module-template
bun add npm-module-template
```

## 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.5 |
| Published | 2016-04-14 |
| First published | 2016-04-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5.0 <6 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | BaHwan Han |
| Maintainers | beingbook |

## Links

- npm: https://www.npmjs.com/package/npm-module-template
- Repository: https://github.com/Beingbook/npm-module-template
- Homepage: https://github.com/Beingbook/npm-module-template#readme
- Issues: https://github.com/Beingbook/npm-module-template/issues
- npm.io page: https://npm.io/package/npm-module-template

## Recent versions

- 1.0.5 (latest) — 2016-04-14
- 1.0.4 — 2016-04-14
- 1.0.3 — 2016-04-14
- 1.0.2 — 2016-04-14
- 1.0.1 — 2016-04-14
- 1.0.0 — 2016-04-14

## README

# NPM Module Template
[![npm version](https://badge.fury.io/js/npm-module-template.svg?flat-square)](https://badge.fury.io/js/npm-module-template)
[![Dependency Status](https://david-dm.org/beingbook/npm-module-template.svg?style=flat-square)](https://david-dm.org/beingbook/npm-module-template)
[![devDependency Status](https://david-dm.org/beingbook/npm-module-template/dev-status.svg?style=flat-square)](https://david-dm.org/beingbook/npm-module-template#info=devDependencies)

[![NPM](https://nodei.co/npm/npm-module-template.png)](https://nodei.co/npm/npm-module-template/)

With below, you can write down your own npm module quickly.

* [Babel](http://babeljs.io/): A JavaScript compiler. Use next generation JavaScript, today. Basically, it includes [ES2015](http://babeljs.io/docs/plugins/preset-es2015/) + [Stage 2](http://babeljs.io/docs/plugins/preset-stage-2/) presets.
* [Flow](http://flowtype.org/): A static type checker, designed to quickly find errors in JavaScript applications. Now only supports Unix.
* [ESLint](http://eslint.org/): The pluggable linting utility for JavaScript and JSX. Default configuration is [eslint-config-airbnb/base](https://www.npmjs.com/package/eslint-config-airbnb#eslint-config-airbnbbase).
* [Mocha](http://mochajs.org/): A feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
* [Chai](http://chaijs.com/): A BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.

## Usage

### Requirements
* NPM
* Git Client

### Installation

```sh
git clone https://github.com/Beingbook/npm-module-template.git my-module
cd my-moudle
npm install
```

### Lint

```sh
npm run lint
```

### Test

```sh
npm test
```

### Build and Deployment

You should edit your modules identifier in `package.json` before you publish your module.

```sh
npm run build
npm version [major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
npm publish
```

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