mirror of
https://github.com/FranP-code/create-better-t-stack.git
synced 2025-10-12 23:52:15 +00:00
128 lines
3.0 KiB
Plaintext
128 lines
3.0 KiB
Plaintext
---
|
||
title: Quick Start
|
||
description: Create your first Better-T-Stack project in minutes
|
||
---
|
||
|
||
## Philosophy
|
||
|
||
- With Better T Stack, you freely choose only the parts you want; nothing extra is added.
|
||
- Pick your frontend, backend, API layer, database, ORM, auth, addons — or skip any of them. Compatibility is enforced.
|
||
- No lock‑in: it’s a generator, not a framework fork.
|
||
|
||
## Get Started
|
||
|
||
### Stack Builder (UI)
|
||
|
||
- Visit [/new](/new) to pick your stack and copy the generated command
|
||
- Or open it via:
|
||
|
||
```bash
|
||
bun create better-t-stack@latest builder
|
||
```
|
||
|
||
### CLI (prompts)
|
||
|
||
```bash
|
||
bun create better-t-stack@latest
|
||
```
|
||
|
||
Follow the interactive prompts to choose your frontend, backend, database, ORM, API layer, and addons.
|
||
|
||
Skip prompts and use the default stack:
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-app --yes
|
||
```
|
||
|
||
Prefer a visual flow? Use the Stack Builder at [/new](/new) to pick your stack and copy the generated command. You can also open it via:
|
||
|
||
```bash
|
||
bun create better-t-stack@latest builder
|
||
```
|
||
|
||
## Common Setups
|
||
|
||
### Default Stack
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-webapp \
|
||
--frontend tanstack-router \
|
||
--backend hono \
|
||
--database sqlite \
|
||
--orm drizzle \
|
||
--auth \
|
||
--addons turborepo
|
||
```
|
||
|
||
### Convex + React
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-convex-app \
|
||
--frontend tanstack-router \
|
||
--backend convex
|
||
```
|
||
|
||
### API Only
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-api \
|
||
--frontend none \
|
||
--backend fastify \
|
||
--runtime node \
|
||
--database postgres \
|
||
--orm prisma \
|
||
--api trpc
|
||
```
|
||
|
||
### Mobile App (Expo)
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-native \
|
||
--frontend native-nativewind \
|
||
--backend hono \
|
||
--database sqlite \
|
||
--orm drizzle \
|
||
--auth
|
||
```
|
||
|
||
### Empty Monorepo
|
||
|
||
```bash
|
||
bun create better-t-stack@latest my-workspace \
|
||
--frontend none \
|
||
--backend none
|
||
```
|
||
|
||
## Flags Cheat Sheet
|
||
|
||
See the full list in the [CLI Reference](/docs/cli). Key flags:
|
||
|
||
- `--frontend`: tanstack-router, react-router, tanstack-start, next, nuxt, svelte, solid, native-nativewind, native-unistyles, none
|
||
- `--backend`: hono, express, fastify, elysia, next, convex, none
|
||
- `--runtime`: bun, node, workers, none
|
||
- `--database`: sqlite, postgres, mysql, mongodb, none
|
||
- `--orm`: drizzle, prisma, mongoose, none
|
||
- `--api`: trpc, orpc, none
|
||
- `--addons`: turborepo, pwa, tauri, biome, husky, starlight, none
|
||
- `--examples`: todo, ai, none
|
||
|
||
## Next Steps
|
||
|
||
<Cards>
|
||
<Card href="/docs/cli" title="CLI (per-command)">
|
||
Flags, usage, and examples for each command
|
||
</Card>
|
||
<Card href="/docs/project-structure" title="Project Structure">
|
||
See how web/server/native and Convex layouts are generated
|
||
</Card>
|
||
<Card href="/docs/compatibility" title="Compatibility">
|
||
Valid combinations for backend, runtime, database, ORM, API
|
||
</Card>
|
||
<Card href="/docs/bts-config" title="bts.jsonc">
|
||
Required for the add command; safe to delete if you don’t use add
|
||
</Card>
|
||
<Card href="/docs/contributing" title="Contributing">
|
||
Dev setup and contribution flow
|
||
</Card>
|
||
</Cards>
|