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

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

Last synced: about 1 month 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 (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-05T21:28:07.000Z (5 months ago)
• Last Synced: 2024-11-17T00:33:48.397Z (3 months ago)
• Language: JavaScript
• Size: 1.47 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• 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

```