Skip to content

infra-blocks/ts-lib-template

Repository files navigation

ts-lib-template

Build Release Trigger Update From Template codecov

This repository is a template to generate repositories meant to hold the source code of NPM packages written in TypeScript.

Follow these steps after instantiating the template:

  • Do a global search & replace for ts-lib-template and replace it with the name of your repository
  • Likewise, do a search and replace for the name of the package in the package.json file
  • Remove the trigger update from template workflow
  • Set up code coverage, overwrite the codecov badge with the specific link for your repository.
  • Replace the Trigger Update From Template status badge for the Update From Template status badge.
  • Update package.json
    • Edit the search keywords
    • Edit the description
  • Describe the package and its usage in this readme.
  • Prepare the changelog for the first version of the module that will be released.
  • Edit the .npmrc file if you wish to change the defaults. Specifically, if you wish to make your package private.