Minimal Library Starter Kit for your Typescript projects
- 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
git clone https://github.com/kothing/webpack-vanilla-typescript-library-template.git
npm install
Before shipping, make sure to:
- Edit
LICENSE
file - Edit
package.json
information (These will be used to generate the headers for your built files) - Edit
library: "MyLibrary"
with your library's export name in./webpack.config.js
npm publish
- Your users can include your library as usual
import MyLibrary from 'my-library';
const libraryInstance = new MyLibrary();
...
<script src="dist/index.js"></script>
const MyLibrary = window.MyLibrary.default;
const libraryInstance = new MyLibrary();
...
Made a library using this starter kit? Share it here by submitting a pull request!