create-x4 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # create-x4
2
+
3
+ Scaffold a full-stack TypeScript monorepo with [x4](https://github.com/corbanb/x4-mono).
4
+
5
+ ## Quick Start
6
+
7
+ ```bash
8
+ bunx create-x4 my-app
9
+ cd my-app
10
+ cp .env.example .env.local
11
+ bun db:push
12
+ bun dev
13
+ ```
14
+
15
+ Or with npm:
16
+
17
+ ```bash
18
+ npx create-x4 my-app
19
+ ```
20
+
21
+ ## What You Get
22
+
23
+ - **API** — Hono + tRPC v11 (port 3002)
24
+ - **Web** — Next.js 15 App Router (port 3000)
25
+ - **Mobile** — Expo + React Native
26
+ - **Desktop** — Electron
27
+ - **Marketing** — Next.js static site (port 3001)
28
+ - **Docs** — Fumadocs (port 3003)
29
+ - **Database** — Neon Postgres + Drizzle ORM
30
+ - **Auth** — Better Auth with bearer tokens
31
+ - **AI** — Vercel AI SDK + Claude
32
+ - **CI/CD** — GitHub Actions with Neon branching
33
+
34
+ ## Options
35
+
36
+ ```
37
+ Usage: create-x4 [project-name] [options]
38
+
39
+ Arguments:
40
+ project-name Directory and monorepo name (e.g., my-app)
41
+
42
+ Options:
43
+ -s, --scope <scope> npm scope for packages (default: @{project-name})
44
+ --bundle-id <id> Reverse-domain prefix (default: com.{project-name})
45
+ --no-mobile Exclude Expo mobile app
46
+ --no-desktop Exclude Electron desktop app
47
+ --no-marketing Exclude marketing site
48
+ --no-docs Exclude docs site
49
+ --no-ai Exclude AI integration package
50
+ --pm <manager> Package manager: bun|npm|yarn|pnpm (default: auto-detect)
51
+ --no-git Skip git initialization
52
+ --no-install Skip dependency installation
53
+ --branch <branch> Template branch (default: main)
54
+ -v, --verbose Verbose output
55
+ --version Print version
56
+ -h, --help Print help
57
+ ```
58
+
59
+ ## Examples
60
+
61
+ Create with a custom npm scope:
62
+
63
+ ```bash
64
+ bunx create-x4 my-app --scope @acme
65
+ ```
66
+
67
+ Web + API only (no mobile, desktop, marketing, or docs):
68
+
69
+ ```bash
70
+ bunx create-x4 my-app --no-mobile --no-desktop --no-marketing --no-docs
71
+ ```
72
+
73
+ Skip dependency installation:
74
+
75
+ ```bash
76
+ bunx create-x4 my-app --no-install
77
+ ```
78
+
79
+ ## License
80
+
81
+ MIT