https://github.com/ajayns/npm-module-boilerplate

Boilerplate that uses the latest tools and best practices to kickstart building a npm module
https://github.com/ajayns/npm-module-boilerplate

boilerplate module node-module npm plugin

Last synced: 23 days ago
JSON representation

Boilerplate that uses the latest tools and best practices to kickstart building a npm module

• Host: GitHub
• URL: https://github.com/ajayns/npm-module-boilerplate
• Owner: ajayns
• Created: 2018-04-17T02:31:40.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-20T17:49:36.000Z (about 8 years ago)
• Last Synced: 2025-09-09T18:00:04.097Z (9 months ago)
• Topics: boilerplate, module, node-module, npm, plugin
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# NPM Module Boilerplate

Boilerplate that uses the latest tools and best practices to kickstart building a npm module.

## Features

* Transpiles from ES6+ (including ES7, ES8) using the latest Babel plugin

* Has basic example to get started with easily

## Development

Assuming you have the current version of Node (8.11.1 LTS) and NPM (5.6.0) installed.

Install all the required packages/dependencies

### `npm install`

Build the source code

### `npm build`

Test if module working

### `node example`

## Checklist

- [ ] Add a testing framework (Jest?)

- [ ] Keep track of code coverage, generate reports

- [ ] Continuous Integration with Travis

## Contributing

Feel free to open issues and pull requests!