Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iwharris/typescript-starter

Boilerplate repo for personal Typescript projects
https://github.com/iwharris/typescript-starter

Last synced: 1 day ago
JSON representation

Boilerplate repo for personal Typescript projects

Host: GitHub
URL: https://github.com/iwharris/typescript-starter
Owner: iwharris
License: mit
Created: 2020-01-14T03:22:06.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-08T22:46:35.000Z (almost 2 years ago)
Last Synced: 2023-02-26T20:56:58.505Z (over 1 year ago)
Language: JavaScript
Size: 1.15 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # typescript-starter

[![codecov](https://codecov.io/gh/iwharris/typescript-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/iwharris/typescript-starter)

[![Build](https://github.com/iwharris/typescript-starter/actions/workflows/ci.yaml/badge.svg)](https://github.com/iwharris/typescript-starter/actions/workflows/ci.yaml)

Boilerplate repo for personal Typescript projects

## Components

| Component/Framework                                            | Purpose                | Comments                                                                   |

| -------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------- |

| [Jest](https://jestjs.io/)                                     | Test Framework         | Using [ts-jest](https://github.com/kulshekhar/ts-jest) for JIT compilation |

| [Prettier](https://prettier.io/)/[ESLint](https://eslint.org/) | Code style & linting   |

| [GitHub Actions](https://github.com/features/actions)          | Continuous Integration |

| [Codecov](https://codecov.io/)                                 | Code coverage tracking |

## Usage

### Compile

```bash

# Compile typescript to dist/

npm run compile

# Compile in watch mode

npm run watch

```

### Lint

```bash

# Check for style issues

npm run prettier

# Automatically fix style issues

npm run prettier:fix

```

### Test

```bash

# Run test suite

npm test

# Generate a coverage report

npm run test:coverage

```

### CI/CD

To publish a new version to npm:

```bash

npm version patch # or minor, or major

git push

git push --tags

```