create-t3-app README

The project's README from github.com/t3-oss/create-t3-app. As one markdown file: README.md.

Logo for T3

create-t3-app

Interactive CLI to start a full-stack, typesafe Next.js app.

Get started with the T3 Stack by running npm create t3-app@latest

PRs-Welcome Discord NPM version Downloads

Video thumbnail of Theo with an indecipherable expression on his face

Watch Theo's overview on Youtube here

Table of contents

The T3 Stack

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

So... what is create-t3-app? A template?

Kind of? create-t3-app is a CLI built by seasoned T3 Stack devs to streamline the setup of a modular T3 Stack app. This means each piece is optional, and the "template" is generated based on your specific needs.

After countless projects and many years on this tech, we have lots of opinions and insights. We’ve done our best to encode them into this CLI.

This is NOT an all-inclusive template. We expect you to bring your own libraries that solve the needs of YOUR application. While we don’t want to prescribe solutions to more specific problems like state management and deployment, we do have some recommendations listed here.

T3 Axioms

We'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 into 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 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 since it's just functions that are trivial to move off.

3. Typesafety Isn't Optional

The stated goal of create-t3-app is to provide the quickest way to start a new full-stack, typesafe web application. We take typesafety seriously in these parts as it improves our productivity and helps us ship fewer bugs. Any decision that compromises the typesafe nature of create-t3-app is a decision that should be made in a different project.

Getting Started

To scaffold an app using create-t3-app, run any of the following four commands and answer the command prompt questions:

npm

npm create t3-app@latest

yarn

yarn create t3-app

pnpm

pnpm create t3-app@latest

bun

bun create t3-app@latest

For more advanced usage, check out the CLI docs.

Community

For help, discussion about best practices, or any other conversation that would benefit create-t3-app:

Join the T3 Discord Server

Contributors

We 💖 contributors! Feel free to contribute to this project but please read the Contributing Guidelines before opening an issue or PR so you understand the branching strategy and local development environment. We also welcome you to join our Discord community for either support or contributing guidance.

A table of avatars from the project's contributors

Made with contrib.rocks

Powered by vercel

create-t3-app (t3-oss/create-t3-app)

Searching Database…

29.2K ·GitHub
Create-t3-app
Что это такое?create-t3-app — это интерактивный CLI, который генерирует готовое фулстек-приложение на Next.js с типобезопасностью, построенное на T3 Stack — наборе инструментов для веб-разработки, ориентированном на простоту, модульность и сквозную типобезопасность.
Это готовый шаблон или инструмент, который я запускаю?Это CLI, а не фиксированный шаблон: каждая часть стека опциональна, и приложение собирается под ваши конкретные задачи по ходу ответов на вопросы.
Как создать новое приложение с его помощью?Запустите npm create t3-app@latest — также поддерживаются варианты с yarn, pnpm и bun — и ответьте на вопросы в терминале.
Что должно быть установлено перед запуском?Node.js 20 или новее (требование из engines в репозитории) и любой один пакетный менеджер: npm, yarn, pnpm или bun.
В чём подвох — не загоняет ли он меня в свои рамки?Он откровенно придерживается собственных принципов: добавит не всё — никаких библиотек состояния вроде zustand или redux — и это отправная точка, а не шаблон «всё включено»; библиотеки вы добавляете сами.
Есть ли разница, работаю ли я на macOS, Windows или Linux?Нет — это консольный инструмент, который работает везде, где работает Node.js, так что macOS, Windows и Linux подойдут.
Что именно оказывается в сгенерированном приложении?Те части T3 Stack, которые вы выбрали: Next.js, tRPC, Tailwind CSS, TypeScript, Prisma или Drizzle для базы данных и NextAuth.js для аутентификации.
Почему не включена библиотека управления состоянием вроде Redux?Так задумано. Аксиомы T3 гласят: всё добавляемое должно решать задачу, которую не решают основные технологии. Библиотеки состояния вроде zustand и redux прямо исключены, а NextAuth.js и интеграция Prisma/tRPC — включены.
Как он относится к самым свежим, ещё сырым технологиям?Он «рискует ответственно»: не ставит на рискованные новые СУБД — SQL через Prisma или Drizzle считается безопасным выбором, — зато охотно берёт tRPC, поскольку это просто функции, которые легко перенести на что-то другое.
Подскажет ли он, как развернуть готовое приложение?Без жёстких предписаний. Как и управление состоянием, деплой остаётся на вас, хотя в README есть ссылки на рекомендации команды.
What are similar projects?cal.diy, Next-js-Boilerplate, react-starter-kit, AgentGPT, blitz, generator-jhipster, open-saas, noodle
Which topics is it in?fullstack, scaffolding, npx, typesafe, starter-kit, prisma, drizzle-orm, tailwindcss, sql, cli-tool, nextjs, hacktoberfest
Creator
t3-oss
Size
8.3 MB
Stars
29.2K
Updated
CommitDec 13Release[email protected]Nov 05
Age
4y
Commits · 90 Days