https://github.com/kainstar/typescript-npm-package-template

Template to kickstart creating a Node.js module using TypeScript and VSCode
https://github.com/kainstar/typescript-npm-package-template

Last synced: about 1 month ago
JSON representation

Template to kickstart creating a Node.js module using TypeScript and VSCode

• Host: GitHub
• URL: https://github.com/kainstar/typescript-npm-package-template
• Owner: kainstar
• License: mit
• Created: 2022-04-23T08:03:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T03:15:41.000Z (8 months ago)
• Last Synced: 2024-09-22T21:19:39.758Z (about 2 months ago)
• Language: TypeScript
• Size: 647 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# my-package-name

[![npm package][npm-img]][npm-url] [![Build Status][build-img]][build-url] [![Downloads][downloads-img]][downloads-url] [![Issues][issues-img]][issues-url] [![Code Coverage][codecov-img]][codecov-url] [![Commitizen Friendly][commitizen-img]][commitizen-url] [![Semantic Release][semantic-release-img]][semantic-release-url]

> My awesome module, use my [typescript-npm-package-template](https://github.com/kainstar/typescript-npm-package-template/blob/main/QUICK_START.md) as project boilerplate

## Install

```bash

npm install my-package-name

```

## Usage

```ts

import { myPackage } from 'my-package-name';

myPackage('hello');

//=> 'hello from my package'

```

[build-img]: https://github.com/kainstar/typescript-npm-package-template/actions/workflows/release.yml/badge.svg

[build-url]: https://github.com/kainstar/typescript-npm-package-template/actions/workflows/release.yml

[downloads-img]: https://img.shields.io/npm/dt/@kainstar/typescript-npm-package-template

[downloads-url]: https://www.npmtrends.com/@kainstar/typescript-npm-package-template

[npm-img]: https://img.shields.io/npm/v/@kainstar/typescript-npm-package-template

[npm-url]: https://www.npmjs.com/package/@kainstar/typescript-npm-package-template

[issues-img]: https://img.shields.io/github/issues/kainstar/typescript-npm-package-template

[issues-url]: https://github.com/kainstar/typescript-npm-package-template/issues

[codecov-img]: https://codecov.io/gh/kainstar/typescript-npm-package-template/branch/main/graph/badge.svg

[codecov-url]: https://codecov.io/gh/kainstar/typescript-npm-package-template

[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

[semantic-release-url]: https://github.com/semantic-release/semantic-release

[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[commitizen-url]: http://commitizen.github.io/cz-cli/