A quickstart-friendly repo template with comprehensive, opinionated tooling.
@mfaith/create is a one-stop-shop solution to set up a new repository with the latest and greatest TypeScript tooling and open source conventions.
It includes options not just for building and testing but also automated release management, contributor recognition, GitHub repository settings, and more.
First make sure you have the following installed:
- Node.js
- pnpm
- (optional, but helpful) GitHub CLI (you'll need to be logged in)
pnpm create @mfaithYou can read more about the supported runtime modes in their docs pages:
- Setting up from the terminal: creating a new repository locally on the command-line (recommended)
- Transitioning an existing repository: adding this template's tooling on top of an existing repository
- Using the template repository: creating a new repository with the Use this template button on GitHub
You can read more about @mfaith/create and the tooling it supports:
- Blocks: a breakdown of all the pieces this template can set up.
- CLI: providing granular options to customize how the template is run.
- FAQs: frequently asked questions and troubleshooting
Note
This project was forked with 💖 from create-typescript-app.
See CONTRIBUTING, then DEVELOPMENT.
michael faith 🐛 💻 🎨 📖 🤔 🚇 🚧 👀 |
See the LICENSE file for license rights and limitations (MIT).