Library Starter Kit for your Javascript projects
This is a more robust library boilerplate. For a minimal alternative, check out js-library-boilerplate-basic.
- Webpack 5
- Babel 7
- Hot Reloading (
npm start
) - CSS Autoprefixer
- SASS/SCSS support
- UMD exports, so your library works everywhere.
- Based on CRA v5.0.0 (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) - Daily 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.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
let libraryInstance = new MyLibrary();
...
<link href="build/index.css" rel="stylesheet">
<script src="build/index.js"></script>
let MyLibrary = window.MyLibrary.default;
let libraryInstance = new MyLibrary();
...
Made a library using this starter kit? Share it here by submitting a pull request!
- hovercard - Wikipedia summary cards for the web
- perfect-immutable - Library to provide immutable methods
- react-simple-keyboard - React Virtual Keyboard
- redux-better-promise - Simple and powerful redux middleware
- redux-breeze - Powerful redux wrapper
- regex-colorizer - Highlighter for Javascript regex syntax
- simple-keyboard - Javascript Virtual Keyboard
- simple-keyboard-layouts - Layout kit for simple-keyboard