2.2.2 • Published 6 years ago
typescript-webkit v2.2.2
TypeScript Library Boilerplate
Library Starter Kit for your Javascript/TypeScript projects
⭐️ Features
- TypeScript/JavaScript
- Sass/Css
- Webpack 4
- Babel 7
- Hot Reloading (
npm start/yarn start) - CSS Autoprefixer
- UMD exports, so your library works everywhere.
- Based on CRA v3.0.0 (For Vanilla JS libs or React libs)
- Jest unit testing
- Customizable file headers for your build
- Configurable
postinstallmessage (Example) - Weekly dependabot dependency updates
📦 Getting Started
git clone https://github.com/msztorc/typescript-webkit.git myLib
npm install💎 Customization
Before shipping, make sure to: 1. Edit
LICENSEfile 2. Editpackage.jsoninformation (These will be used to generate the headers for your built files) 3. Editlibrary: "myLib"with your library's export name in./config/webpack.config.js4. Edit./bin/postinstall(If you would like to display a message on package install)
🚀 Deployment
npm publish- Your users can include your library as usual
npm
import myLib from 'my-library';
import 'my-library/build/index.css' // If you import a css file in your library
...self-host/cdn
<link href="build/index.css" rel="stylesheet">
<script src="build/index.js"></script>
let myLib = window.myLib.default;
...This is fork of js-library-boilerplate by Francisco Hodge https://github.com/hodgef/js-library-boilerplate.git
License
MIT