/node-pkg-boilerplate

This is a boilerplate for node package creation based on the article of @bookercodes

Primary LanguageJavaScriptMIT LicenseMIT

ES6 Node package boilerplate

Build Status Inline docs Maintainability contributions welcome HitCount Open Source Love MIT Licence

Young Lions Quality Assuranc - Active YoungLions QA - Active
 Read more

This is a simple updated boilerplate for node packages written in ES6 - based on an article How to build and publish ES6 npm modules today with babel written by Alex Booker (Feb 2, 2016).

Package structure

Main target of this package: easy to use and no dependencies

The main changes:

  • extended the main sample - instead the exported function a class is exported (which consists only of one sample - the same funtions as found in the above article)
  • updated babel presets (to babel-preset-env)
  • updated devDependencies versions
  • added sample tests (using chai + mocha)
  • added linting (esLint - google)
  • added additional files usually found in packages - .travis.yml, CONTRIBUTING.md, LICENSE

Getting Started

git clone https://github.com/YoungLionsGroup/node-pkg-boilerplate.git YOUR_PACKAGE_NAME

Installing

cd node-pkg-boilerplate
npm install

Eventually, you would want to change the package.json, source classes & functions to your own names.

Running the tests

  1. npm run build - a /dist folder will be created
  2. npm test

Deployment

If your finished with creating you package, you can publish it on NPM - Read more.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

On this project, no versioning is being conducted. To learn more about versioning please visit SemVer.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments