create-aron-app 0.1.6 → 0.1.8

package/README.md

@@ -1,6 +1,6 @@
 # create-aron-app
 
-> CLI scaffolding tool that stamps out a production-ready Nx monorepo with Convex, Clerk, and either Next.js 15 or React Router v7.
+> CLI scaffolding tool that stamps out a production-ready Nx monorepo with Convex, Clerk, and React Router v7.
 
 ## Usage
 
@@ -14,41 +14,36 @@ bunx create-aron-app
 
 The CLI will ask a few questions and scaffold a new project:
 
-- **Project name** — lowercase alphanumeric + hyphens
-- **Framework** — Next.js 15 (App Router) or React Router v7 (SPA/Vite)
-- **Output directory** — where to create the project (defaults to `~/Desktop/<name>`)
-- **Package manager** — Bun (recommended), pnpm, npm, or Yarn
-- **Install dependencies** — run install automatically
-- **Initialize git** — create an initial commit
+- **Output directory** — where to create the project (defaults to `~/Desktop/my-app`)
+- **Initialize git** — create an initial commit and initial repository
 
 ## What gets scaffolded
 
-The output is an **Nx monorepo** with two apps:
+The output is an **Nx monorepo** with a full-stack React Router v7 application:
 
 ```
 my-app/
 ├── apps/
 │   ├── api/          # Convex backend (convex-ents + Zod validation)
-│   └── web/          # Next.js 15 or React Router v7 frontend
+│   └── react-router/ # React Router v7 frontend (Vite)
 ├── shared/
-│   ├── ui/           # ~20 shadcn/Radix UI components + hooks
-│   ├── utils/        # Convex client helpers, date utils
+│   ├── ui/           # shadcn/Radix UI components + hooks
 │   └── assets/       # global.css (Tailwind 4)
 ├── emails/           # React Email templates
-├── scripts/          # sync_convex_env.ts
 ├── .cursor/          # Pre-configured Cursor AI rules and skills
 └── .github/
     └── workflows/ci.yml
 ```
 
-A working **Todos** feature is wired end-to-end as the canonical example of the data model pattern.
+A working **Todos** feature is wired end-to-end as the canonical example of the surface architecture pattern.
 
 ## Stack
 
 - **Backend** — [Convex](https://docs.convex.dev) with [`convex-ents`](https://labs.convex.dev/convex-ents) for relational modeling and Zod-validated function wrappers
-- **Frontend** — [Next.js 15](https://nextjs.org) (App Router) or [React Router v7](https://reactrouter.com) (SPA/Vite)
+- **Frontend** — [React Router v7](https://reactrouter.com) with Vite
 - **Auth** — [Clerk](https://clerk.com) wired to both Convex and the frontend
-- **Data fetching** — [TanStack Query v5](https://tanstack.com/query)
+- **Data fetching** — [TanStack Query v5](https://tanstack.com/query) with `@convex-dev/react-query`
+- **State management** — [MobX](https://mobx.js.org) with surface architecture pattern
 - **UI** — Radix UI + Tailwind CSS 4 + shared component library
 - **Monorepo** — [Nx](https://nx.dev) with Bun workspaces
 - **Linting** — [Biome](https://biomejs.dev)
@@ -99,14 +94,14 @@ Publishing is also automated via GitHub Actions — creating a GitHub Release tr
 create-aron-app/
 ├── src/
 │   ├── index.ts          # CLI entrypoint (prompts + orchestration)
-│   ├── types.ts          # Shared TS types
 │   └── utils/
-│       ├── constant.ts   # Framework/PM options + dependency lists
-│       └── helpers.ts    # File ops, template merging helpers
-├── templates/
-│   ├── _base/            # Shared monorepo skeleton (copied first)
-│   ├── nextjs/           # Next.js 15 App Router variant
-│   └── react-router/     # React Router v7 SPA variant
+│       └── helpers.ts    # File ops, template copy helpers
+├── templates/            # Complete React Router v7 monorepo template
+│   ├── apps/
+│   │   ├── api/          # Convex backend
+│   │   └── react-router/ # React Router v7 app
+│   ├── shared/           # Shared UI and assets
+│   └── ...               # nx.json, package.json, etc.
 ├── dist/                 # Built CLI output
 └── .github/
     └── workflows/
@@ -115,12 +110,10 @@ create-aron-app/
 
 ### How scaffolding works
 
-1. Copy `templates/_base/` into the output directory
-2. Copy the framework-specific template into `apps/web/`
-3. Rename `_gitignore` files to `.gitignore` (npm strips dotfiles on publish)
-4. Merge framework deps into the root `package.json`
-5. Inject the right Nx plugins into `nx.json`
-6. Replace the `project:` placeholder with the actual project name in all `project.json` files
-7. Promote `apps/web/.env.example` to the root as `.env.example`
-8. Optionally: `git init` + initial commit
-9. Optionally: `<pm> install`
+1. Copy the entire `templates/` directory to the output location
+2. Rename `_gitignore` files to `.gitignore` (npm strips dotfiles on publish)
+3. Set the project name in the root `package.json`
+4. Promote `apps/react-router/.env.example` to the root as `.env.example`
+5. Copy local `.env.router` to `.env.local` if it exists (for local development only)
+6. Optionally: `git init` + initial commit
+7. Run `bun install` to install dependencies