Need help with prod-module-boilerplate?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

cloverfield-tools
190 Stars 14 Forks MIT License 129 Commits 3 Opened issues

Description

An npm `scripts` boilerplate for modules intended for production.

Services available

!
?

Need anything else?

Contributors list

prod-module-boilerplate Circle CI

Travis-CI Gitter

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.

Contents

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.

Customize the README.md file

Pop open README.md. Find this text:

[![Travis-CI](https://travis-ci.org/cloverfield-tools/prod-module-boilerplate.svg)](https://travis-ci.org/cloverfield-tools/prod-module-boilerplate)

And replace it with your info:

[![Travis-CI](https://travis-ci.org//.svg)](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
  npm run build

It will run webpack once building full and minified versions of your library in

./build
with sourcemaps.
  1. For development
  npm start

This will run the

webpack
build in watch mode and will include ESLint checks on compile time.

webpack

Note minified version will not be built in dev mode.

Contributing

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.