web3-lib-name
v0.0.7
Published
Typescript Minimal Starter Kit for building libraries
Downloads
4
Readme
For a plain Javascript alternative, check out js-library-boilerplate-basic.
⭐️ Features
- Webpack 5
- Babel 7
- Hot reloading (
npm start
) - Automatic Types file generation (index.d.ts)
- 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/ts-library-boilerplate-basic.git myLibrary
npm install
💎 Customization
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
🚀 Deployment
npm publish
- 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();
...
✅ Libraries built with this boilerplate
Made a library using this starter kit? Share it here by submitting a pull request!
- simple-keyboard - Javascript Virtual Keyboard
- react-simple-keyboard - React Virtual Keyboard
- simple-keyboard-layouts - Keyboard layouts for simple-keyboard