https://github.com/JoshuaKGoldberg/create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝
https://github.com/JoshuaKGoldberg/create-typescript-app

eslint javascript node package prettier template typescript

Last synced: 10 months ago
JSON representation

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝

Host: GitHub
URL: https://github.com/JoshuaKGoldberg/create-typescript-app
Owner: JoshuaKGoldberg
License: mit
Created: 2022-10-01T06:32:37.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-24T20:57:47.000Z (over 1 year ago)
Last Synced: 2024-10-29T15:21:36.851Z (over 1 year ago)
Topics: eslint, javascript, node, package, prettier, template, typescript
Language: TypeScript
Homepage:
Size: 3.92 MB
Stars: 1,171
Watchers: 7
Forks: 75
Open Issues: 69
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

awesome-starred - JoshuaKGoldberg/create-typescript-app - Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁 (TypeScript)

README

          
Create TypeScript App




	Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling.

	🎁





	

	

	

	

	

	

	

	

	





`create-typescript-app` is a one-stop-shop solution to set up a new or existing repository with the latest and greatest TypeScript tooling.

It includes options not just for building and testing but also automated release management, contributor recognition, GitHub repository settings, and more.

## Usage

First make sure you have the following installed:

- [Node.js](https://nodejs.org)

- [pnpm](https://pnpm.io)

- _(optional, but helpful)_ [GitHub CLI](https://cli.github.com) _(you'll need to be logged in)_

Then in an existing repository or in your directory where you'd like to make a new repository:

```shell

npx create-typescript-app

```

You can read more about the supported runtime modes in their docs pages:

- [**Setting up from the terminal**](./docs/Setup.md): creating a new repository locally on the command-line _(recommended)_

- [**Transitioning an existing repository**](./docs/Transition.md): adding this template's tooling on top of an existing repository

- [**Using the template repository**](./docs/UseThisTemplate.md): creating a new repository with the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub

## Documentation

You can read more about `create-typescript-app` and the tooling it supports:

1. [**Blocks**](./docs/Blocks.md): a breakdown of all the pieces this template can set up.

2. [**CLI**](./docs/CLI.md): providing granular options to customize how the template is run.

3. [**FAQs**](./docs/FAQs.md): frequently asked questions and troubleshooting

> [!NOTE]  

> This template is opinionated and not endorsed by the TypeScript team.

> It can be configured to set up a _lot_ of tooling out of the box.

> If you don't want to use any particular tool, you can always remove it manually.

## Development

See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).

Thanks! 🎁

## Contributors

  

    

      
_{Alex / KATT}
🐛

      
_Anurag
💻

      
_{Atila Fassina}
🐛

      
_{Biplob Sutradhar}
💻

      
_{Christopher Hiller}
🤔

      
_{Conor Meagher}
💻

      
_{Dan Vanderkam}
🐛 🤔 🔧

    

    

      
_Daniel
🚇

      
_{Daniel Roe}
💻

      
_{Demian Parkhomenko}
🐛 💻

      
_{Dominic Duffin}
💻

      
_{Dominik Nowik}
🔧 💻 🤔

      
_Emerson
💻

      
_{Faraz Patankar}
🐛

    

    

      
_{Felix Boehm}
🐛

      
_{Graham Vasquez}
💻

      
_{Jamie Magee}
🤔

      
_{Jan-Niklas W.}
💻

      
_{Jeff Wen}
💻

      
_{Jessica Wilkins}
💻

      
_{Joe Previte}
🐛 💻

    

    

      
_{John Reilly}
💻 🤔 🐛 🚧 📖 🔧

      
_{Josh Goldberg}
🐛 💻 🚧 👀 🔧 📖 🚇 ⚠️ 🤔 🎨

      
_{Joël Galeran}
💻

      
_{Juan A.}
💻 📖

      
_{Kristo Baricevic}
💻

      
_{Lars Kappert}
💻

      
_{Mohammad Bagher Abiyat}
💻

    

    

      
_{Nate May}
🐛

      
_{Navin Moorthy}
🐛 💻 🤔

      
_NazCodeland
💻

      
_{Orta Therox}
💻 🤔

      
_{Paul Esch-Laurent}
💻

      
_{Pelle Wessman}
🤔

      
_{Praveen Shinde}
💻

    

    

      
_{Promise Dash}
💻

      
_{Rebecca Stevens}
💻 🚇

      
_{Ron Braha}
💻 🎨 ⚠️

      
_{Ron Jean-Francois}
💻 🚇

      
_Ruthwik
💻

      
_{Ryota Murakami}
💻 🐛

      
_Shraddha
💻

    

    

      
_Sudhansu
💻

      
_{Swastik Patel}
📖

      
_{Timon Jurschitsch}
💻

      
_{Tung Bui (Leo)}
💻

      
_Valon
📖

      
_{Vasanth Kumar Cheepurupalli}
💻

      
_{Xiaomin Liu}
💻

    

    

      
_lcforbes
🐛

      
_{michael faith}
💻 🐛

      
_nandertga
💻

      
_{rubiesonthesky}
🤔 💻

      
_takanomedev
💻

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/JoshuaKGoldberg/create-typescript-app

Awesome Lists containing this project

README

Create TypeScript App