Skip to content

Latest commit

 

History

History
157 lines (100 loc) · 4.61 KB

README.md

File metadata and controls

157 lines (100 loc) · 4.61 KB

create-t3-app

Interactive CLI to quickly set up a project using the T3 Stack


PRs-Welcome NPM version Downloads

Usage

npm

npx create-t3-app@latest

yarn

yarn create t3-app

pnpm

pnpm dlx create-t3-app@latest

Table of contents

What is this? Some kinda template?

Kind of. We love all of the technologies that create-t3-app includes, but we do NOT believe every project needs all of them.

We made create-t3-app to do one thing - simplify the complex boilerplate around the core T3 Stack tech without compromising the modularity of the pieces.

This is NOT an all-inclusive template. We don't add things that are as simple as an npm install zustand. If you cut an issue asking us to add your preferred libraries, we will make fun of you.

What is the T3 Stack?

The "T3 Stack" is a web development stack made by Theo, focused on simplicity, modularity, and full-stack typesafety.

Watch the video

Watch Theo's overview on Youtube here

It consists of

If you're looking for more info about this stack (state management solutions, deployment recommendations, etc) - check out init.tips

T3 Axioms

I'll be frank - this is an opinionated project. We share a handful of core beliefs around building, and we treat them as the basis for our decisions.

1. Solve Problems

It's easy to fall in the trap of "adding everything" - we explicitly don't want to do that. Everything added to create-t3-app should solve a specific problem that exists within the core technologies included.

This means we won't add things like state libraries (zustand, redux), but we will add things like NextAuth.js and integrate it with Prisma and tRPC for you

2. Bleed Responsibly

We love our bleeding edge tech. The amount of speed and, honestly, fun that comes out of new shit is really cool. We think it's important to bleed responsibly, using riskier tech in the less risky parts.

This means we wouldn't bet on risky new database tech (SQL is great!) - but we happily bet on tRPC (it's just functions, moving off it is trivial).

3. Typesafety Isn't Optional

Two of the three T's are typesafe (Typescript, tRPC). We take typesafety seriously in these parts. Any decision that compromises the full-stack typesafe nature of create-t3-app is a decision that should be made in a different project.

Dev/Contributor Setup

Read the Contributing guidelines

To install dependencies

# Install pnpm
npm install -g pnpm
# Install dependencies
pnpm install
# Initial build
pnpm run build
# Start the package locally
pnpm start

Contributors

We 💖 contributors! Feel free to contribute to this project

Made with contrib.rocks.

Powered by vercel