Initialization.md

Initializing from the Template

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
pnpm i

💡 If you don't want to clone it locally, you can always develop in a codespace instead.

Once the repository's packages are installed, you can run pnpm run initialize to fill out your repository's details and install necessary packages. It will then remove itself and uninstall dependencies only used for initialization.

pnpm run initialize

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

1. Create two tokens in repository secrets (unless you chose to opt out of releases):
   • ACCESS_TOKEN: A GitHub PAT with repo and workflow permissions
   • NPM_TOKEN: An npm access token with Automation 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! 🥳

Options

You can explicitly provide some or all of the options the script would prompt for as command-line flags. See Options.md.

pnpm run initialize will set --mode to initialize.

For example, running the initialization script and skipping all GitHub-related APIs:

pnpm run initialize --skip-all-contributors-api --skip-github-api

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