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:
- Remove the trigger update from template workflow
- Configure code coverage
- Update the .nvmrc version file to latest
- Update the package.json
- Rename the package name and links
- Edit the search keywords
- Update the
engines
section
- Update the dependencies
- Run
nvm install
- Run
npm install
- Run
npm run compile && npm run lint && npm run test
- Edit the
.npmrc
file if you wish to change the defaults. Specifically, if you wish to make your package private. - Update the status badges:
- Remove the
Trigger Update From Template
status badge. - Add the
Update From Template
status badge. - Rename the rest of the links to point to the right repository.
- Remove the
- Edit this readme to correspond to the package.