https://github.com/flex-development/ts-package-starter

TypeScript package starter
https://github.com/flex-development/ts-package-starter

npm typescript yarn

Last synced: 6 days ago
JSON representation

TypeScript package starter

• Host: GitHub
• URL: https://github.com/flex-development/ts-package-starter
• Owner: flex-development
• License: bsd-3-clause
• Created: 2022-08-21T06:05:57.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-23T04:33:18.000Z (12 months ago)
• Last Synced: 2024-05-01T09:40:38.982Z (7 months ago)
• Topics: npm, typescript, yarn
• Language: JavaScript
• Homepage:
• Size: 1.22 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.config.cts
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# project-name

[![npm](https://img.shields.io/npm/v/@flex-development/project-name.svg)](https://npmjs.com/package/@flex-development/project-name)

[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)

[![license](https://img.shields.io/github/license/flex-development/project-name.svg)](LICENSE.md)

[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)

[![github actions](http://img.shields.io/badge/-github%20actions-2088ff?style=flat&logo=github-actions&logoColor=ffffff)](https://github.com/features/actions)

[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)

[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)

[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

**TODO**: Update project description.

## Contents

- [What is this?](#what-is-this)

- [When should I use this?](#when-should-i-use-this)

- [Install](#install)

- [Use](#use)

- [API](#api)

- [Types](#types)

- [Contribute](#contribute)

## What is this?

**TODO**: Update documentation.

## When should I use this?

**TODO**: Update documentation.

## Install

This package is [ESM only][1].

```sh

yarn add @flex-development/project-name

```

From Git:

```sh

yarn add @flex-development/project-name@flex-development/project-name

```



  

    See Git - Protocols | Yarn

     for details on requesting a specific branch, commit, or tag.

  



## Use

**TODO**: Update documentation.

## API

**TODO**: Update documentation.

## Types

This package is fully typed with [TypeScript][2].

## Contribute

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

[1]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[2]: https://www.typescriptlang.org