Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloverfield-tools/prod-module-boilerplate
An npm `scripts` boilerplate for modules intended for production.
https://github.com/cloverfield-tools/prod-module-boilerplate
Last synced: 4 months ago
JSON representation
An npm `scripts` boilerplate for modules intended for production.
- Host: GitHub
- URL: https://github.com/cloverfield-tools/prod-module-boilerplate
- Owner: cloverfield-tools
- License: mit
- Created: 2015-06-01T21:04:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-06T21:28:02.000Z (almost 9 years ago)
- Last Synced: 2024-06-22T20:23:39.722Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 187
- Watchers: 16
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# prod-module-boilerplate [](https://circleci.com/gh/cloverfield-tools/prod-module-boilerplate/tree/master)
[](https://travis-ci.org/cloverfield-tools/prod-module-boilerplate)
[](https://gitter.im/learn-javascript-courses/javascript-questions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
An npm `scripts` boilerplate for modules intended for production.
## Status
This project is no longer actively maintained, and has been replaced by the [`cf-package` Cloverfield generator](https://github.com/cloverfield-tools/cf-package).
## Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Clone the repo](#clone-the-repo)
- [Customize package.json](#customize-packagejson)
- [Configure your CI build](#configure-your-ci-build)
- [Customize the README.md file](#customize-the-readmemd-file)
- [Build your module](#build-your-module)
- [Contributing](#contributing)
## Features
* ES6 with Babel
* Lint with ESLint
* Tape tests with coverage report
* Dependency security audits with nsp
* Ensure dependencies are properly declared in package.json
* Git precommit hook enforces quality checks on commit
* Travis CI integration
## Getting Started
### Clone the repo
In a bash terminal:
```
git clone [email protected]:cloverfield-tools/prod-module-boilerplate.git
cd
rm -rf <.git> # strip the boilerplate .git config
git init # create your own .git config
git add .
git commit -m 'Initial commit'
```
### Customize package.json
Open up `package.json`. At minimum, you'll need to customize the `name`, `description`, & `version` fields.
### Configure your CI build
This package comes with a `.travis.yml` file. You'll need to replace it with your own build config. If you want to continue using TravisCI and you don't see any problems with the config, replacing `.travis.yml` is optional. You still need to activate [Travis CI for your repository](http://docs.travis-ci.com/user/getting-started/).
### Customize the README.md file
Pop open README.md. Find this text:
```
[](https://travis-ci.org/cloverfield-tools/prod-module-boilerplate)
```
And replace it with your info:
```
[](https://travis-ci.org//)
```
You'll probably also want to replace the content of "Getting Started" & "Features", and ensure that you're refering to the correct repository in the "Contributing" document.
### Build your module
1. For production
```sh
npm run build
```
It will run webpack once building full and minified versions of your library in `./build` with sourcemaps.
2. For development
```sh
npm start
```
This will run the `webpack` build in watch mode and will include ESLint checks on compile time.
**Note** minified version will not be built in dev mode.
## Contributing
- [Contributing](docs/contributing/index.md)
- [Versions: Release Names vs Version Numbers](docs/contributing/versions/index.md)