Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 3.42 KB

README.md

File metadata and controls

69 lines (50 loc) · 3.42 KB
Raw

Javascript Library Boilerplate Basic

Minimal Library Starter Kit for your Javascript projects

npm version lastest commit Build Status Publish Status

If you like TypeScript, check out ts-library-boilerplate-basic.
Want a more robust (yet bulkier) alternative? Check out js-library-boilerplate.

⭐️ Features

  • Webpack 5
  • Babel 7
  • Hot reloading (npm start)
  • UMD exports, so your library works everywhere.
  • Jest unit testing
  • Customizable file headers for your build (Example 1) (Example2)
  • Daily dependabot dependency updates

📦 Getting Started

git clone https://github.com/hodgef/js-library-boilerplate-basic.git GleapHelper
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: "GleapHelper" 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 GleapHelper from 'my-library';
const libraryInstance = new GleapHelper();
...

self-host/cdn

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

const GleapHelper = window.GleapHelper.default;
const libraryInstance = new GleapHelper();
...

✅ Libraries built with this boilerplate

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