js-library-boilerplate-basic - A Mininal Javascript Library Boilerplate

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 .

:star:️ Features

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

:package: Getting Started

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

:gem: 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

:rocket: Deployment

npm publish

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.

:white_check_mark: Libraries built with this boilerplate

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