An npm `scripts` boilerplate for modules intended for production.
scriptsboilerplate for modules intended for production.
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'
package.json. At minimum, you'll need to customize the
This package comes with a
.travis.ymlfile. 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.ymlis optional. You still need to activate Travis CI for your repository.
Pop open README.md. Find this text:
And replace it with your info:
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.
npm run build
It will run webpack once building full and minified versions of your library in
This will run the
webpackbuild in watch mode and will include ESLint checks on compile time.
Note minified version will not be built in dev mode.