@thinhnguyencth1204/nextcli 0.6.1 → 0.7.0

package/README.md

@@ -17,7 +17,7 @@ node dist/cli.js --help
 
 ## Command: create
 
-Create a new project from the base template:
+Create a new project from the minimal base template:
 
 ```bash
 node dist/cli.js create
@@ -27,18 +27,40 @@ This command is fully interactive:
 
 - enter project name
 - select package manager in CLI UI (`npm`, `pnpm`, `yarn`, `bun`)
-- multi-select optional modules (`chat`, `supabase-realtime`, `seo`, `email`)
+- multi-select optional modules (see module list below)
 - confirm install step
 - normalizes project directory name into a safe project slug for generated `package.json` and env placeholders
 - ships `SETUP.md` and `PROJECT_STRUCTURE.md` in the generated project root
 
-## Core auth in base template
+**Default output is minimal:** Next.js shell, branding, theme, and UI primitives only. Database, auth, dashboard, and other stacks are added only when selected.
 
-Generated projects now include:
+## Optional modules
+
+Available during `create` and `add module`:
+
+| Module              | Adds                                                          |
+| ------------------- | ------------------------------------------------------------- |
+| `database`          | Prisma schema, client, `DATABASE_URL`, db scripts             |
+| `supabase`          | Supabase browser client + Storage helpers                     |
+| `auth`              | Better Auth, sign-in pages, user APIs, bootstrap admin        |
+| `api`               | Axios client, API envelope helpers, React Query provider      |
+| `i18n`              | next-intl config, messages, locale switcher (auto-adds `api`) |
+| `dashboard`         | Protected dashboard shell, sidebar, data-table UI             |
+| `example`           | Starter CRUD demo + `Example` Prisma model                    |
+| `chat`              | Chat routes, hooks, Prisma chat models (+ auto deps)          |
+| `supabase-realtime` | Realtime channel helpers (+ auto `supabase`)                  |
+| `seo`               | robots/sitemap/JSON-LD helpers                                |
+| `email`             | Email helper + React Email templates (SMTP or Resend)         |
+
+Module dependencies are auto-added (e.g. `auth` → `database`, `dashboard` → `auth` + `api` + `i18n`, `chat` → `database` + `supabase-realtime` + `supabase`).
+
+## Auth module (`auth`)
+
+When selected, generated projects include:
 
 - Better Auth + Prisma adapter with JWT + username plugins
 - username/password sign-in (`/sign-in`) and forced password change (`/change-password`)
-- default bootstrap user `admin` / `admin` (must change password on first login)
+- default bootstrap user `admin` / `admin1234` (must change password on first login)
 - hierarchical RBAC (`Role.level`) and user CRUD under `/api/v1/users`
 - account sample page (`/account`)
 - auth API wrappers:
@@ -48,7 +70,7 @@ Generated projects now include:
   - `GET /api/v1/auth/me`
   - `POST /api/v1/auth/change-password`
 
-Axios setup is split:
+Axios setup (`api` module):
 
 - `publicApi`: public calls
 - `protectedApi`: bearer token calls with 401 refresh queue + retry
@@ -63,18 +85,18 @@ Project-owned routes under `/api/v1/*` use a unified envelope:
 - Error:
   - `{ success: false, error: { code, message, details? }, timestamp, requestId? }`
 
-This is powered by `src/lib/api-response.ts` in generated apps.
+This is powered by `src/lib/api/response.ts` when the `api` module is enabled.
 The Better Auth passthrough route `/api/auth/[...all]` remains unwrapped.
 
 ## Command: add feature
 
-Run inside a generated project root:
+Run inside a generated project root (requires `database` and `api` for full CRUD wiring):
 
 ```bash
 node ../dist/cli.js add feature orders
 ```
 
-`add feature` now always creates:
+`add feature` creates:
 
 - `src/features/<feature>/api/use-<feature>.ts`
 - `src/features/<feature>/components/`
@@ -92,27 +114,20 @@ node ../dist/cli.js add module
 
 Module copy is non-destructive: existing files are kept and reported as skipped conflicts.
 
-Interactive multiselect shows available module catalog:
-
-- `chat`
-- `supabase-realtime`
-- `seo`
-- `email`
-
 Non-interactive example:
 
 ```bash
-node ../dist/cli.js add module --module seo --module supabase-realtime --yes
+node ../dist/cli.js add module --module database --module auth --module dashboard --yes
 ```
 
-`supabase` is no longer an optional module; Supabase client, Storage helpers, and Supabase Postgres env placeholders are part of the base template.
-`resend` is now handled by the `email` module (legacy `--module resend` maps to `email` with provider `resend`).
+`--module supabase` installs the Supabase client + Storage module.
+`resend` is handled by the `email` module (legacy `--module resend` maps to `email` with provider `resend`).
 
 When `email` is selected, CLI asks for provider (`resend` or `smtp`) and only merges env keys/dependencies for that provider.
 
 ## Command: add auth-provider
 
-Enable social auth providers after project creation (not created by default):
+Enable social auth providers after the `auth` module is installed:
 
 ```bash
 node ../dist/cli.js add auth-provider
@@ -131,13 +146,13 @@ node ../dist/cli.js add auth-provider --provider google --provider facebook --ye
 
 This command:
 
-- updates `src/lib/auth.ts` provider block
+- updates `src/lib/auth/server.ts` provider block
 - merges provider env keys into `.env`, `.env.example`, and `.env.development`
 - runs Better Auth schema generation helper (with install prompt if CLI is missing in interactive mode)
 
 ## Command: migrate
 
-Run Prisma migration script automatically from project root:
+Run Prisma migration script automatically from project root (requires `database` module):
 
 ```bash
 node ../dist/cli.js migrate
@@ -148,37 +163,34 @@ Optional flags:
 - `--name <migration-name>`: set migration name manually
 - `--skip-generate`: pass through to `prisma migrate dev --skip-generate`
 
-Example:
-
-```bash
-node ../dist/cli.js migrate --name init_auth --skip-generate
-```
+## Generated stack (when modules selected)
 
-## Generated stack
-
-- Next.js App Router + TypeScript
-- Better Auth + Prisma adapter
-- Supabase as the default Postgres/Storage stack
-- Prisma ORM (`prisma/schema.prisma`, `prisma/migrations`)
-- Axios fetch wrapper
-- TanStack React Query
-- TanStack React Table
-- TanStack React Form (dependency included for form workflows)
-- shadcn-style shared UI folder
-- Zod validation
-- i18n base with `next-intl`
-- Sonner notifications
-- date-fns utility library
-- Optional modules: chat, supabase-realtime, seo, email
+- Next.js App Router + TypeScript (base)
+- Better Auth + Prisma (`database` + `auth`)
+- Supabase client + Storage (`supabase`)
+- Axios + React Query (`api`)
+- next-intl (`i18n`)
+- Dashboard shell + TanStack Table (`dashboard`)
+- shadcn-style shared UI folder (base)
+- Zod validation (base)
+- Sonner notifications (base)
+- Optional: chat, supabase-realtime, seo, email
 
 ## Template structure
 
-Base template lives in:
+Minimal base template:
 
 - `templates/next-base`
 
 Optional module templates:
 
+- `templates/features/database`
+- `templates/features/supabase`
+- `templates/features/auth`
+- `templates/features/api`
+- `templates/features/i18n`
+- `templates/features/dashboard`
+- `templates/features/example`
 - `templates/features/chat`
 - `templates/features/supabase-realtime`
 - `templates/features/seo`
@@ -189,10 +201,9 @@ Optional module templates:
 Chatbox Prisma entities are appended only when you add the `chat` module
 (during `create` or via `add module --module chat`).
 
-When chat is selected, NexTCLI auto-adds `supabase-realtime` if missing.
+When chat is selected, NexTCLI auto-adds `database`, `supabase-realtime`, and `supabase` when missing.
 
-The generated chat schema is provider-agnostic so you can plug in Supabase Realtime,
-WebSocket, Pusher, or any transport later without redesigning data:
+The generated chat schema is provider-agnostic:
 
 - `ChatConversation`
 - `ChatParticipant`