Publish to NPM with TypeScript, CircleCI and GitHub Releases.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
src Use CircleCI v2 Workflows (#1) Oct 17, 2017
test
.gitignore
.npmignore
CODE_OF_CONDUCT.md
LICENSE.md
README.md
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

TypeScript NPM Boilerplate

npm CircleCI license Coveralls

A basic boilerplate to write JavaScript NPM modules in TypeScript. The TypeScript code is compiled to JavaScript and published to NPM using CircleCI v2 Workflows and GitHub Releases.

More details at: https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html

Features

Usage

Fork this repository, download it, or clone it and add your custom files and configurations.

NPM Tasks

  • test - Run jest
  • test:cover - Run jest and create coverage report
  • coveralls - Publish coverage report to Coveralls
  • lint - Run tslint
  • build - Build JavaScript files

Configuration

CircleCI

You need to configure two environment variables in CircleCI, one for publishing to NPM and one for Coveralls coverage reports.

  • NPM_TOKEN
  • COVERALLS_REPO_TOKEN

License

Feel free to use the code, it's released using the MIT license.

Contribution

You are welcome to contribute to this project! 😘

To make sure you have a pleasant experience, please read the code of conduct. It outlines core values and beliefs and will make working together a happier experience.