Skip to content
Javascript Starter Boilerplate - Webpack 4, Babel 7, UMD, Hot Reloading, and more
Branch: master
Clone or download
Latest commit f399664 Apr 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Initial Setup Nov 8, 2018
build Build update Apr 14, 2019
config Add demo config Nov 17, 2018
demo Updating deps Nov 25, 2018
public Initial Setup Nov 8, 2018
scripts Using compiler.hooks for dev server test mode Mar 17, 2019
src
.gitignore Including build Nov 9, 2018
.npmignore
.travis.yml
LICENSE Initial Setup Nov 8, 2018
README.md Update README.md Dec 22, 2018
package-lock.json
package.json

README.md

Javascript Library Boilerplate

Library Starter Kit for your Javascript projects

⭐️ Features

  • 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

📦 Getting Started

git clone https://github.com/hodgef/js-library-boilerplate.git myLibrary
npm install

💎 Customization

Before shipping, make sure to:

  1. Edit LICENSE file
  2. Edit package.json information (These will be used to generate the headers for your built files)
  3. Edit library: "MyLibrary" with your library's export name in ./config/webpack.config.prod.js
  4. Edit ./bin/postinstall (If you would like to display a message on package install)

🚀 Deployment

  1. npm publish
  2. Your users can include your library as usual

npm

import MyLibrary from 'my-library';
import 'my-library/build/index.css' // If you import a css file in your library
...

self-host/cdn

<link href="build/index.css" rel="stylesheet">
<script src="build/index.js"></script>

let MyLibrary = window.MyLibrary.default;
...

Libraries built with this boilerplate

Made a library using this starter kit? Share it here by submitting a pull request!

You can’t perform that action at this time.