icodein / js-library-boilerplate-basic Goto Github PK

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.

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

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

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

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

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

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

const MyLibrary = window.MyLibrary.default;
const 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.

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

• Canvas-Txt - A library to print multiline text on HTML5 canvas with better line breaks and alignments
• moon-phase-widget - Super tiny javascript library to add awesome moon phase widget to your website
• simple-keyboard-autocorrect - Autocorrect module for simple-keyboard
• simple-keyboard-input-mask - Input mask module for simple-keyboard
• simple-keyboard-key-navigation - Key navigation module for simple-keyboard
• swipe-keyboard - Swype type keyboard module for simple-keyboard