Skip to content

README.tpl.md

Latest commit

 

History

History
44 lines (27 loc) · 2.12 KB

README.tpl.md

File metadata and controls

44 lines (27 loc) · 2.12 KB

%PACKAGE_NAME%

Build Status codecov semantic-release

Additional badges for public repositories

GitHub issues npm version devDependencies Status dependencies Status

%PACKAGE_DESCRIPTION%

Requirements

This project requires nodejs to be installed on your system.

Setup

Install project dependencies

  • npm install

Tests

  • npm run test will run karma and test your code. Will also create a code coverage report at /coverage.
  • Optional: Use WallabyJS for continous testing.

Code styles

This project uses tslint to enforce similar code styles across source and test files. Passing tslint validation is a CI requirement. You can run and validate your code style locally.

  • npm run lint lints all typescript files in the project.
  • npm run lint-fix to also fix most common errors automatically.

Build and deploy

This package is automatically build and deployed using TravisCI and semantic-release. You can however test the process locally:

  • npm run build compile sources into all desired formats.
  • npm run pack to create the final package.

Note: You'll have to edit package.json to include a version number of your choice. Don't check this in though as the version number is determined by semantic-release.