Skip to content

A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨

License

Notifications You must be signed in to change notification settings

dominicduffin1/create-typescript-app

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Create TypeScript App

A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨

All Contributors: 23 🤝 Codecov Test Coverage Code of Conduct: Enforced 🤝 License: MIT 📝 Sponsor: On GitHub 💸 Style: Prettier 🧹 TypeScript: Strict 💪

Note that this template is early stage, opinionated, and not endorsed by the TypeScript team. It sets up a lot of tooling out of the box. Each of the included tools exists for a good reason and provides real value.

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

Getting Started

First make sure you have the following installed:

This repository comes with three script forms to set up an existing or new repository with tooling. Use the corresponding docs page to get started:

Explainer

This template is available for anybody who wants to set up a Node application using TypeScript. It sets up the following tooling for you:

  • All Contributors: Tracks various kinds of contributions and displays them in a nicely formatted table in the README.md.
  • ESLint: Static analysis for JavaScript code, configured with typescript-eslint for TypeScript code and other general-use plugins.
  • Knip: Detects unused files, dependencies, and code exports.
  • Markdownlint: Static analysis for Markdown code.
  • pnpm: Disk-efficient package manager alternative.
  • PR Compliance Action: Checks PRs for compliance such as addressing a linked issue and proper title formatting.
  • Prettier: Opinionated formatting for code, run on file save and as a Git commit hook via husky and lint-staged.
  • release-it: Generates changelogs, bumps the package version, and publishes to GitHub and npm based on conventional commits.
  • Renovate: Keeps dependencies up-to-date with PRs, configured to wait a few days after each update for safety.
  • tsup: Builds output definitions and JavaScript files using esbuild.
  • TypeScript: A typed superset of JavaScript, configured with strict compiler options.
  • Vitest: Fast unit tests, configured with coverage tracking and console-fail-test.

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md. Thanks! 💖

Contributors

Anurag
Anurag

💻
Daniel Roe
Daniel Roe

💻
Dominik Nowik
Dominik Nowik

🔧 💻
Emerson
Emerson

💻
Jeff Wen
Jeff Wen

💻
Joe Previte
Joe Previte

🐛 💻
John Reilly
John Reilly

💻
Josh Goldberg
Josh Goldberg

🐛 💻 🚧 👀 🔧 📖 🚇 ⚠️
Joël Galeran
Joël Galeran

💻
Kristo Baricevic
Kristo Baricevic

💻
Lars Kappert
Lars Kappert

💻
Navin Moorthy
Navin Moorthy

🐛 💻
NazCodeland
NazCodeland

💻
Orta Therox
Orta Therox

💻
Paul Esch-Laurent
Paul Esch-Laurent

💻
Promise Dash
Promise Dash

💻
Rebecca Stevens
Rebecca Stevens

💻 🚇
Ron Braha
Ron Braha

💻 🎨 ⚠️
Ron Jean-Francois
Ron Jean-Francois

💻 🚇
Ryota Murakami
Ryota Murakami

💻
Sudhansu
Sudhansu

💻
Tung Bui (Leo)
Tung Bui (Leo)

💻
takanomedev
takanomedev

💻

About

A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.0%
  • JavaScript 5.0%