NPM Module Template

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

• Babel: A JavaScript compiler. Use next generation JavaScript, today. Basically, it includes ES2015 + Stage 2 presets.
• Flow: A static type checker, designed to quickly find errors in JavaScript applications. Now only supports Unix.
• ESLint: The pluggable linting utility for JavaScript and JSX. Default configuration is eslint-config-airbnb/base.
• Mocha: A feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
• Chai: 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

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

Lint

npm run lint

Test

npm test

Build and Deployment

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

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