https://github.com/wincent/minimal-npm-boilerplate
Minimal boilerplate for creating an NPM package
https://github.com/wincent/minimal-npm-boilerplate
Last synced: 17 days ago
JSON representation
Minimal boilerplate for creating an NPM package
- Host: GitHub
- URL: https://github.com/wincent/minimal-npm-boilerplate
- Owner: wincent
- License: mit
- Created: 2015-08-04T18:19:24.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-13T03:40:47.000Z (over 10 years ago)
- Last Synced: 2025-01-05T15:43:34.630Z (over 1 year ago)
- Language: JavaScript
- Size: 137 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# minimal-npm-boilerplate
Minimal boilerplate for creating an NPM package. Includes:
- gulp-powered build and watch tooling
- Mocha/Sinon.JS test set-up
- eslint
- Flow
- Babel for transpiling ES2015+ features to ES5 prior to publishing
Clone, `npm install`, modify, and `npm publish`.
## Install
```sh
$ npm install --save minimal-npm-boilerplate
```
## Usage
```js
import index from 'minimal-npm-boilerplate';
index();
```
## Links
- Source: [github.com/wincent/minimal-npm-boilerplate](https://github.com/wincent/minimal-npm-boilerplate)
- Package: [www.npmjs.com/package/minimal-npm-boilerplate](https://www.npmjs.com/package/minimal-npm-boilerplate)
## License
### The MIT License (MIT)
Copyright (c) 2015-present Greg Hurrell
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.