2.2.2 • Published 5 years ago

typescript-webkit v2.2.2

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Build Status License

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 postinstall message (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 LICENSE file 2. Edit package.json information (These will be used to generate the headers for your built files) 3. Edit library: "myLib" with your library's export name in ./config/webpack.config.js 4. Edit ./bin/postinstall (If you would like to display a message on package install)

🚀 Deployment

  1. npm publish
  2. 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