https://github.com/greetclock/typescript-lib-boilerplate

Skeleton for TypeScript libraries
https://github.com/greetclock/typescript-lib-boilerplate

boilerplate-template typescript

Last synced: about 2 months ago
JSON representation

Skeleton for TypeScript libraries

• Host: GitHub
• URL: https://github.com/greetclock/typescript-lib-boilerplate
• Owner: greetclock
• License: mit
• Created: 2017-11-30T16:47:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T02:09:35.000Z (over 3 years ago)
• Last Synced: 2025-01-22T21:45:23.489Z (over 1 year ago)
• Topics: boilerplate-template, typescript
• Language: JavaScript
• Size: 4.26 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TypeScript library boilerplate

A boilerplate for TypeScript libraries. Webpack, tests, Typedoc. Just clone, run `npm i` and start build your TypeScript library 🔥

Change `MyLib` in three files: `.eslintrc`, `examples/developing/main.js`, `webpack/common.config.js`.

Scripts:

* `npm start` and `npm run dev` - run a server with hot reloading available at `localhost:8080`.

* `npm test` and `npm run watch:test` - run tests with [Karma](https://karma-runner.github.io/1.0/index.html). Single run and watch mode.

* `npm run build` - builds and minifies your library. Also generates documentation using Typedoc. Builds in [UMD](https://github.com/umdjs/umd) format, so it can be used both in browser and Node.js.

* `npm run typedoc` - generates documentation.

* `npm run check-updates` - checks dependendency updates.

[Alexey Karpov](https://github.com/cherurg)