franpcode/create-better-t-stack
1
0
Fork 0
mirror of https://github.com/FranP-code/create-better-t-stack.git synced 2025-10-12 23:52:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(web): improve docs and readme

Browse Source
This commit is contained in:
Aman Varshney
2025-08-08 17:33:15 +05:30
parent 51cfb35912
commit 2df8d44af3
10 changed files with 416 additions and 688 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
apps/cli/README.md
View File

@@ -15,14 +15,14 @@ A modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with
Run without installing globally:
```bash
# Using npm
npx create-better-t-stack@latest
# Using bun
# Using bun (recommended)
bun create better-t-stack@latest
# Using pnpm
pnpm create better-t-stack@latest
# Using npm
npx create-better-t-stack@latest
```
Follow the prompts to configure your project or use the `--yes` flag for defaults.
@@ -58,14 +58,15 @@ Options:
--auth Include authentication
--no-auth Exclude authentication
--frontend <types...> Frontend types (tanstack-router, react-router, tanstack-start, next, nuxt, svelte, solid, native-nativewind, native-unistyles, none)
--addons <types...> Additional addons (pwa, tauri, starlight, biome, husky, turborepo, none)
--addons <types...> Additional addons (pwa, tauri, starlight, biome, husky, turborepo, fumadocs, ultracite, oxlint, none)
--examples <types...> Examples to include (todo, ai, none)
--git Initialize git repository
--no-git Skip git initialization
--package-manager <pm> Package manager (npm, pnpm, bun)
--install Install dependencies
--no-install Skip installing dependencies
--db-setup <setup> Database setup (turso, d1, neon, supabase, prisma-postgres, mongodb-atlas, none)
--db-setup <setup> Database setup (turso, d1, neon, supabase, prisma-postgres, mongodb-atlas, docker, none)
--web-deploy <setup> Web deployment (workers, none)
--backend <framework> Backend framework (hono, express, elysia, next, convex, fastify, none)
--runtime <runtime> Runtime (bun, node, workers, none)
--api <type> API type (trpc, orpc, none)
@@ -84,7 +85,7 @@ This CLI collects anonymous usage data to help improve the tool. The data collec
### Disabling Telemetry
You can disable telemetry by setting the `BTS_TELEMETRY` environment variable:
You can disable telemetry by setting the `BTS_TELEMETRY_DISABLED` environment variable:
```bash
# Disable telemetry for a single run
@@ -94,10 +95,6 @@ BTS_TELEMETRY_DISABLED=1 npx create-better-t-stack my-app
export BTS_TELEMETRY_DISABLED=1
```
### Development
During development, telemetry is automatically disabled when `NODE_ENV=development`.
## Examples
Create a project with default configuration:
@@ -118,10 +115,10 @@ Create a project with Elysia backend and Node.js runtime:
npx create-better-t-stack my-app --backend elysia --runtime node
```
Create a project with multiple frontend options:
Create a project with multiple frontend options (one web + one native):
```bash
npx create-better-t-stack my-app --frontend tanstack-router native
npx create-better-t-stack my-app --frontend tanstack-router native-nativewind
```
Create a project with examples: