Skip to content

UseThisTemplate.md

Latest commit

 

History

History
34 lines (24 loc) · 1.49 KB

UseThisTemplate.md

File metadata and controls

34 lines (24 loc) · 1.49 KB

Using the Template Repository

As an alternative to creating with npx create-typescript-app, the Use this template button on GitHub can be used to quickly create a new repository from the template. You can set up the new repository locally by cloning it and installing packages:

git clone https://github.com/YourUsername/YourRepositoryName
cd YourRepositoryName
npx create-typescript-app

You'll then need to manually go through the following two steps to set up tooling on GitHub:

  1. Create one token in repository secrets (unless you chose to opt out of releases):
    • ACCESS_TOKEN: A GitHub PAT with repo and workflow permissions
  2. Install two GitHub apps:
    • Codecov (unless you chose to opt out of tests)
    • Renovate (unless you chose to opt out of renovate)

Your new repository will then be ready for development! Hooray! 🥳

CLI Options

You can customize which pieces of tooling are provided and the options they're created with. See CLI.md.

For example, skipping the "This package was templated with..." block:

npx create-typescript-app --exclude-templated-with

See Blocks.md for details on the tooling pieces and which presets they're included in.