nodeneeds-npm

Node Needs NPM is a starter repo for building opensource nodejs modules.

Usage no npm install needed!

<script type="module">
  import nodeneedsNpm from 'https://cdn.skypack.dev/nodeneeds-npm';
</script>

README

nodeneeds-npm

npm latest version Build Status Maintainability Test Coverage

nodeneeds-npm is an out of the box node project which can be used to get started on building an NPM package with all the best development practicies.

The features baked in include:

  • Coding Standard (ES6, ESLint)
  • Testing Framework (Chai, Mocha & Sinon.JS)
  • Code Management (Git, Conventional Commits, Changelog)
  • Continuos Integration Support (Travis CI)

Credits

Chandra Shekar Chennamsetty

And of course nodeneeds itself is open source with a public repository on GitHub.

Installation

nodeneeds requires Node.js v8+ to run. You can fork/clone this project and customize it for your needs. We recommened using nodeneeds-cli, the command line tool to bootstrap a new npm bundle from this project. Use it to provide the details of your new npm package and let the cli prepare the project for you. Once your project ( lets call it mynodepackage ) is ready do the following:

Install the dependencies and devDependencies and start building your package.

$ cd mynodepackage
$ yarn
$ yarn lint
$ yarn test
$ yarn test:coverage
$ yarn build

To publish your package

$ yarn release

Todos

  • Update dependencies latest versions.

License

MIT

Free Software, Hell Yeah!