- Webpack 4
- Babel 7
- Hot Reloading (
npm start
) - CSS Autoprefixer
- UMD exports, so your library works everywhere.
- Based on CRA v2.1.1 (For Vanilla JS libs or React libs)
- Jest unit testing
npm run demo
To build a ready-for-deployment demo (Example)- Customizable file headers for your build (Example 1) (Example2)
- Configurable
postinstall
message (Example) - Weekly dependabot dependency updates
git clone https://github.com/hodgef/js-library-boilerplate.git myLibrary
npm install
Before shipping, make sure to:
- Edit
LICENSE
file - Edit
package.json
information (These will be used to generate the headers for your built files) - Edit
library: "MyLibrary"
with your library's export name in./config/webpack.config.prod.js
- Edit
./bin/postinstall
(If you would like to display a message on package install)
npm publish
- Your users can include your library as usual
import MyLibrary from 'my-library';
import 'my-library/build/index.css' // If you import a css file in your library
...
<link href="build/index.css" rel="stylesheet">
<script src="build/index.js"></script>
let MyLibrary from window.MyLibrary.default;
...