Skip to content

Commit e21f6de

Browse files
generate better readme
1 parent e29f344 commit e21f6de

File tree

9 files changed

+352
-145
lines changed

9 files changed

+352
-145
lines changed

.changeset/eager-lizards-lose.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"create-better-t-stack": patch
3+
---
4+
5+
generate better readme

apps/cli/README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Follow the prompts to configure your project or use the `--yes` flag for default
2727
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2828
| **TypeScript** | End-to-end type safety across all parts of your application |
2929
| **Frontend** | • React with TanStack Router<br>• React with React Router<br>• React with TanStack Start (SSR)<br>• Next.js<br>• SvelteKit<br>• Nuxt (Vue)<br>• SolidJS<br>• React Native with NativeWind (via Expo)<br>• React Native with Unistyles (via Expo)<br>• None |
30-
| **Backend** | • Hono<br>• Express<br>• Elysia<br>• Next.js API routes<br>• Convex<br>• Fastify<br>• None |
30+
| **Backend** | • Hono<br>• Express<br>• Elysia<br>• Next.js API routes<br>• Convex<br>• Fastify<br>• None |
3131
| **API Layer** | • tRPC (type-safe APIs)<br>• oRPC (OpenAPI-compatible type-safe APIs)<br>• None |
32-
| **Runtime** | • Bun<br>• Node.js |
32+
| **Runtime** | • Bun<br>• Node.js<br>• Cloudflare Workers<br>• None |
3333
| **Database** | • SQLite<br>• PostgreSQL<br>• MySQL<br>• MongoDB<br>• None |
3434
| **ORM** | • Drizzle (TypeScript-first)<br>• Prisma (feature-rich)<br>• Mongoose (for MongoDB)<br>• None |
35-
| **Database Setup** | • Turso (SQLite)<br>• Neon (PostgreSQL)<br>• Prisma Postgres (via Prisma Accelerate)<br>• MongoDB Atlas<br>• None (manual setup) |
35+
| **Database Setup** | • Turso (SQLite)<br>• Cloudflare D1 (SQLite)<br>• Neon (PostgreSQL)<br>• Supabase (PostgreSQL)<br>• Prisma Postgres (via Prisma Accelerate)<br>• MongoDB Atlas<br>• None (manual setup) |
3636
| **Authentication** | Better-Auth (email/password, with more options coming soon) |
3737
| **Styling** | Tailwind CSS with shadcn/ui components |
3838
| **Addons** | • PWA support<br>• Tauri (desktop applications)<br>• Starlight (documentation site)<br>• Biome (linting and formatting)<br>• Husky (Git hooks)<br>• Turborepo (optimized builds) |
@@ -59,9 +59,9 @@ Options:
5959
--package-manager <pm> Package manager (npm, pnpm, bun)
6060
--install Install dependencies
6161
--no-install Skip installing dependencies
62-
--db-setup <setup> Database setup (turso, neon, prisma-postgres, mongodb-atlas, none)
62+
--db-setup <setup> Database setup (turso, d1, neon, supabase, prisma-postgres, mongodb-atlas, none)
6363
--backend <framework> Backend framework (hono, express, elysia, next, convex, fastify, none)
64-
--runtime <runtime> Runtime (bun, node, none)
64+
--runtime <runtime> Runtime (bun, node, workers, none)
6565
--api <type> API type (trpc, orpc, none)
6666
-h, --help Display help
6767
```
@@ -104,6 +104,12 @@ Create a project with Turso database setup:
104104
npx create-better-t-stack my-app --database sqlite --orm drizzle --db-setup turso
105105
```
106106

107+
Create a project with Supabase PostgreSQL setup:
108+
109+
```bash
110+
npx create-better-t-stack my-app --database postgres --orm drizzle --db-setup supabase --auth
111+
```
112+
107113
Create a project with Convex backend:
108114

109115
```bash
@@ -116,10 +122,48 @@ Create a project with documentation site:
116122
npx create-better-t-stack my-app --addons starlight
117123
```
118124

125+
Create a minimal TypeScript project with no backend:
126+
127+
```bash
128+
npx create-better-t-stack my-app --backend none --frontend tanstack-router
129+
```
130+
131+
Create a backend-only project with no frontend:
132+
133+
```bash
134+
npx create-better-t-stack my-app --frontend none --backend hono --database postgres --orm drizzle
135+
```
136+
137+
Create a simple frontend-only project:
138+
139+
```bash
140+
npx create-better-t-stack my-app --backend none --frontend next --addons none --examples none
141+
```
142+
143+
Create a Cloudflare Workers project:
144+
145+
```bash
146+
npx create-better-t-stack my-app --backend hono --runtime workers --database sqlite --orm drizzle --db-setup d1
147+
```
148+
149+
Create a minimal API-only project:
150+
151+
```bash
152+
npx create-better-t-stack my-app --frontend none --backend hono --api trpc --database none --addons none
153+
```
154+
119155
## Compatibility Notes
120156

121157
- **Convex backend**: Automatically disables authentication, database, ORM, and API options
122158
- **Backend 'none'**: If selected, this option will force related options like API, ORM, database, authentication, and runtime to 'none'. Examples will also be disabled (set to none/empty).
159+
- **Frontend 'none'**: Creates a backend-only project. When selected, PWA, Tauri, and certain examples may be disabled.
160+
- **API 'none'**: Disables tRPC/oRPC setup. Can be used with backend frameworks for REST APIs or custom API implementations.
161+
- **Database 'none'**: Disables database setup. Automatically sets ORM to 'none' and disables authentication.
162+
- **ORM 'none'**: Can be used when you want to handle database operations manually or use a different ORM.
163+
- **Runtime 'none'**: Only available with Convex backend or when backend is 'none'.
164+
- **Cloudflare Workers runtime**: Only compatible with Hono backend, Drizzle ORM (or no ORM), and SQLite database (with D1 setup). Not compatible with MongoDB.
165+
- **Addons 'none'**: Skips all addons (PWA, Tauri, Starlight, Biome, Husky, Turborepo).
166+
- **Examples 'none'**: Skips all example implementations (todo, AI chat).
123167
- **SvelteKit, Nuxt, and SolidJS** frontends are only compatible with oRPC API layer
124168
- **PWA support** requires React with TanStack Router, React Router, or SolidJS
125169
- **Tauri desktop app** requires React (TanStack Router/React Router), Nuxt, SvelteKit, or SolidJS

apps/cli/src/constants.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export const dependencyVersionMap = {
9696
"@trpc/server": "^11.4.2",
9797
"@trpc/client": "^11.4.2",
9898

99-
convex: "^1.23.0",
99+
convex: "^1.25.0",
100100
"@convex-dev/react-query": "^0.0.0-alpha.8",
101101
"convex-svelte": "^0.0.11",
102102

0 commit comments

Comments
 (0)