https://github.com/devunltd/ts-library-boilerplate-basic
Typescript Minimal Starter Boilerplate - Webpack 5 🚀, Babel 7, UMD, Unit Testing
https://github.com/devunltd/ts-library-boilerplate-basic
Last synced: about 1 year ago
JSON representation
Typescript Minimal Starter Boilerplate - Webpack 5 🚀, Babel 7, UMD, Unit Testing
- Host: GitHub
- URL: https://github.com/devunltd/ts-library-boilerplate-basic
- Owner: DevUnltd
- License: mit
- Created: 2021-03-07T07:59:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T08:44:18.000Z (about 1 year ago)
- Last Synced: 2025-03-29T23:08:37.747Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 7.23 MB
- Stars: 97
- Watchers: 2
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Typescript Library Boilerplate Basic
Minimal Library Starter Kit for your Typescript projects
For a plain Javascript alternative, check out [js-library-boilerplate-basic](https://github.com/hodgef/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)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/index.js) [(Example2)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/css/index.css)
- Daily [dependabot](https://dependabot.com) dependency updates
## 📦 Getting Started
```
git clone https://github.com/hodgef/ts-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
```
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](https://github.com/hodgef/ts-library-boilerplate-basic/pulls)!
- [simple-keyboard](https://github.com/hodgef/simple-keyboard) - Javascript Virtual Keyboard
- [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard) - React Virtual Keyboard
- [simple-keyboard-layouts](https://github.com/hodgef/simple-keyboard-layouts) - Keyboard layouts for simple-keyboard
- [atlas-monaco](https://github.com/datdao/atlas-monaco) - AtlasHCL for monaco editor