Skip to content

Webpack VanillaJS Typescript Library Boilerplate

License

Notifications You must be signed in to change notification settings

kothing/webpack-vanilla-typescript-library-template

Repository files navigation

Webpack VanillaJs Typescript Library Boilerplate

Minimal Library Starter Kit for your Typescript projects

⭐️ Features

  • Webpack 5
  • Hot reloading
  • VanillaJS
  • Typescript
  • Pure CSS
  • Less
  • Scss
  • Autoprefixer (postcss-loader)
  • Assets(public)
  • Minimization(Image, HTML, CSS, JS) on production
  • UMD exports, so your library works everywhere.
  • Jest unit testing
  • gh-pages Deployment

📦 Getting Started

git clone https://github.com/kothing/webpack-vanilla-typescript-library-template.git
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="dist/index.js"></script>

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

✅ Libraries built with this boilerplate

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

About

Webpack VanillaJS Typescript Library Boilerplate

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published