create-aron-app 0.1.0

package/README.md

@@ -0,0 +1,91 @@
+# create-aron-app
+
+> CLI scaffolding tool for the Convex + Next.js + Clerk + Nx monorepo template.
+
+## Usage
+
+```bash
+npm create aron-app
+# or
+npx create-aron-app
+# or
+bunx create-aron-app
+```
+
+The CLI will ask a few questions and scaffold a new project:
+
+- **Project name** — used as the directory name
+- **Output directory** — where to create the project (defaults to `./<name>`)
+- **Package manager** — Bun, pnpm, npm, or Yarn
+- **Install dependencies** — run install automatically
+- **Initialize git** — create an initial commit
+
+## Development
+
+### Point to your GitHub repo
+
+Edit `src/index.ts` and update `TEMPLATE_SOURCE`:
+
+```ts
+const TEMPLATE_SOURCE = "github:YOUR_USERNAME/project-template";
+```
+
+It uses [`giget`](https://github.com/unjs/giget) under the hood, which supports:
+
+| Format | Example |
+|--------|---------|
+| GitHub | `github:user/repo` |
+| GitHub branch | `github:user/repo#main` |
+| GitHub subdirectory | `github:user/repo/subdir` |
+| GitLab | `gitlab:user/repo` |
+| Bitbucket | `bitbucket:user/repo` |
+
+For local testing, you can point it at a local path instead:
+
+```ts
+const TEMPLATE_SOURCE = "/absolute/path/to/project-template";
+```
+
+### Build
+
+```bash
+cd create
+bun run build
+```
+
+Bundles `src/index.ts` into `dist/index.js` (a single Node.js-compatible file).
+
+### Test locally
+
+```bash
+# Run the built file directly:
+node dist/index.js
+
+# Or link globally for the full npm create experience:
+npm link
+npm create aron-app
+
+# Unlink when done:
+npm unlink -g create-aron-app
+```
+
+### Publish to npm
+
+```bash
+npm publish --access public
+```
+
+## What happens after scaffolding
+
+1. Template is downloaded from GitHub (no git history)
+2. Optionally: `git init` + initial commit
+3. Optionally: `bun install` (or your chosen package manager)
+
+## Stack
+
+- **Backend** — [Convex](https://docs.convex.dev) with `convex-ents` for relational modeling
+- **Frontend** — [Next.js 15](https://nextjs.org) (App Router) + [TanStack Query](https://tanstack.com/query)
+- **Auth** — [Clerk](https://clerk.com)
+- **UI** — Radix UI + Tailwind CSS 4 + custom component library
+- **Monorepo** — [Nx](https://nx.dev) with Bun workspaces
+- **Linting** — [Biome](https://biomejs.dev)