Skip to content

crazyfactory/ts-module-boilerplate

Repository files navigation

ts-module-boilerplate

Greenkeeper badge Build Status GitHub issues codecov devDependencies Status dependencies Status

This boilerplate allows the quick creation of npm modules written in Typescript.

  • Typescript 3.x
  • creates an ES5 bundle
  • creates a TypeScript declaration bundle
  • packs it for npm usage
  • uses jest for testing
  • uses travis and semantic-release for deployment
  • uses linting, coverage and git hooks to increase code quality.
  • is configured to support wallaby

Usage

Initially you should:

  • clone this repository
  • update package.json (name, repository and description)
  • create your own README.md (from the README.tpl.md-file)
  • uncomment after_success block in .travis.yml to activate semantic-release

Afterwards you can start implementing classes and tests :)