Skip to content

HenryTabima/js-library-boilerplate-basic

 
 

Repository files navigation

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!

About

Javascript Minimal Starter Boilerplate - Webpack 4, Babel 7, UMD, Unit Testing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 90.8%
  • CSS 9.2%