Skip to content

A modern template for node modules with lint (ESlint), tests (Mocha and Chai), code coverage (NYC and codecov.io), type checking by JSDocs (TypeScript), CI (TravisCI), semver (semantic-release) and interoperability between ES6 modules and CommonJs and more.

License

Notifications You must be signed in to change notification settings

MauroJr/node-module-boilerplate

Repository files navigation

travis build Dependency Status devDependency Status Codecov MIT License semantic-release

What is it?

A modern template for node modules with lint (ESlint), tests (Mocha and Chai), code coverage (NYC and codecov.io), type checking by JSDocs (TypeScript), CI (TravisCI), semver (semantic-release) and interoperability between ES6 modules and CommonJs and more.

How to use it?

  • clone the repo and remove the .git folder
$ git clone [email protected]:MauroJr/node-module-boilerplate.git my-new-module-name
$ cd my-new-module-name
$ rm -rf .git
  • open the package.json file with your editor and edit the following fields (name, description, repository, author, license and keywords).
  • Edit the README.md file, it's allways good starting here ;)
  • initialize your git repository
$ vim package.json
$ vim README.md
$ git init
$ yarn
$ semantic-release-cli setup
  • Now you are ready to starting to code.
$ vim src/index.js
  • And you must do your commits by the following command:
$ yarn run commit

Do you want more information?

$ yarn run info

About

A modern template for node modules with lint (ESlint), tests (Mocha and Chai), code coverage (NYC and codecov.io), type checking by JSDocs (TypeScript), CI (TravisCI), semver (semantic-release) and interoperability between ES6 modules and CommonJs and more.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published