Awesome Open Source
Awesome Open Source

Javascript Library Boilerplate Basic

Minimal Library Starter Kit for your Javascript projects

Build Status Publish Status

This is a basic library boilerplate. For a more robust alternative, check out js-library-boilerplate.
Like TypeScript? Check out ts-library-boilerplate-basic.

⭐️ Features

  • Webpack 5
  • Babel 7
  • Hot reloading (npm start)
  • 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';
const libraryInstance = new MyLibrary();
...

self-host/cdn

<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.

✅ Libraries built with this boilerplate

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


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,346) 
html (11,162) 
webpack (1,157) 
boilerplate (639) 
babel (356) 
javascript-library (212) 
starter-kit (180) 
webpack4 (109) 
babel7 (21)