Skip to content
Javascript Minimal Starter Boilerplate - Webpack 4, Babel 7, UMD, Unit Testing
JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build Build update Aug 1, 2019
demo 1.0.0 Jun 14, 2019
scripts 1.0.0 Jun 14, 2019
src 1.0.4 Jun 14, 2019
tests 1.0.0 Jun 14, 2019
.gitignore 1.0.0 Jun 14, 2019
.travis.yml 1.0.0 Jun 14, 2019
LICENSE 1.0.0 Jun 14, 2019
README.md Sorting library showcase Jul 3, 2019
babel.config.js 1.0.0 Jun 14, 2019
package-lock.json Bump webpack-cli from 3.3.6 to 3.3.7 Aug 19, 2019
package.json Bump style-loader from 0.23.1 to 1.0.0 Aug 7, 2019
webpack.config.js 1.0.0 Jun 14, 2019

README.md

Javascript Library Boilerplate Basic

Minimal Library Starter Kit for your Javascript projects

This is a basic library boilerplate. For a more robust alternative, check out js-library-boilerplate.

⭐️ Features

  • Webpack 4
  • Babel 7
  • UMD exports, so your library works everywhere.
  • Jest unit testing
  • Daily dependabot dependency updates

📦 Getting Started

git clone https://github.com/hodgef/js-library-boilerplate-basic.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 ./webpack.config.js

🚀 Deployment

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

npm

import MyLibrary from 'my-library';
let libraryInstance = new MyLibrary();
...

self-host/cdn

<script src="build/index.js"></script>

let MyLibrary = window.MyLibrary.default;
let libraryInstance = new MyLibrary();
...

Note: In this minimal version, any images and css files you import will be added to the js bundle. If you want them as separate files, you can use js-library-boilerplate or edit the Webpack config accordingly.

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.