https://github.com/vpksoftorg/npm-ts-template

https://github.com/vpksoftorg/npm-ts-template

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vpksoftorg/npm-ts-template
• Owner: VPKSoftOrg
• License: mit
• Created: 2024-12-14T13:50:37.000Z (20 days ago)
• Default Branch: develop
• Last Pushed: 2024-12-14T13:56:08.000Z (20 days ago)
• Last Synced: 2024-12-14T14:30:50.985Z (20 days ago)
• Language: TypeScript
• Size: 0 Bytes
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npm-ts-template

A [NPM](https://en.wikipedia.org/wiki/Npm) package [TypeScript](https://en.wikipedia.org/wiki/TypeScript) template.

# Getting started

* Change the `name` value from the `package.json` to match your package *name*

* Change the `version` value from the `package.json` to match your package *version*

* Change the `description` value from the `package.json` to match your package *description*

* Change the `keywords` value from the `package.json` to match your package *keywords*

* Change the `author` value from the `package.json` to match your package *author*

* Change the `bugs.url` value from the `package.json` to match your package *bug reporting URL*

* Change the `homepage` value from the `package.json` to match your package *homepage*

# Build, lint and publish

## Build

`npm run build`

## Test

`npm run test`

## Lint

`npm run lint`

## Lint with fixing

`npm run lint-fix`

## Publish

* Set the environment variable `NODE_AUTH_TOKEN` to your own [NPM](https://www.npmjs.com) account token.

* run: `npm publish`