https://github.com/fourkitchens/basic-ts-starter

Extremely simple TypeScript starter codebase
https://github.com/fourkitchens/basic-ts-starter

Last synced: 22 days ago
JSON representation

Extremely simple TypeScript starter codebase

• Host: GitHub
• URL: https://github.com/fourkitchens/basic-ts-starter
• Owner: fourkitchens
• License: mit
• Created: 2021-11-05T19:21:36.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-11-05T19:41:55.000Z (over 4 years ago)
• Last Synced: 2025-03-03T22:38:02.679Z (over 1 year ago)
• Language: JavaScript
• Size: 874 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Basic TypeScript Starter

This is an incredibly bare bones TypeScript project with the following tools configured:

- Yarn 2+

- TypeScript

- Jest

- ESLint

- Prettier

- Husky (with lint-staged)

- Semantic Release

- GitHub Actions

- NVM configuration

The following dependencies should be installed before use:

- NVM

- Yarn 2+

- Node.js LTS

These scripts are available:

- **build**: builds/compiles the project into the `dist` folder.

- **lint**: uses ESLint to lint the codebase.

- **format**: uses Prettier to format all relevant files in the codebase.

- **test**: runs all tests. 100% coverage is expected by default.

- **twatch**: allows you to pass in a single test, and re-start it when you update the file.

- **type**: type checks the the codebase.

The following GitHub Actions are configured:

- **lint**: lints the codebase.

- **test**: runs all tests.

- **release**: runs semantic-release, which by default publishes tags to GitHub.