Boilerplate for Node Packages in typescript

This is a minimalist boilerplate template for Node NPM packages written in Typescript

Get started

Install

yarn

Build

yarn build

Test

yarn test

CI

Continuous integration is included and works with github actions.

Adjust Configuration

Make sure you change the path of the badge (both links and images to link to your package/repo). In package.json make sure you point to your github repo

Badges

You can get standard badges by using the following link: https://nexys-system.github.io/repository-badges/?q=mypackage

Publish

In order to publish your package, add the secret variable NPM_AUTH_TOKEN to the list of secret variables and release a new version

Release a new version

npm version {patch,minor,major}
git push origin master --tags