@thinhnguyencth1204/nextcli 0.1.0

package/README.md

@@ -0,0 +1,197 @@
+# NexTCLI
+
+NexTCLI is an npm-installable CLI to scaffold outsource-ready Next.js projects with a consistent architecture, core integrations, and fast feature generation.
+
+## Install
+
+```bash
+npm install
+npm run build
+```
+
+For local execution:
+
+```bash
+node dist/cli.js --help
+```
+
+## Command: create
+
+Create a new project from the base template:
+
+```bash
+node dist/cli.js create my-nextjs-app
+```
+
+This command is interactive by default:
+- select package manager in CLI UI (`npm`, `pnpm`, `yarn`, `bun`)
+- multi-select optional modules (`chat`, `supabase`, `supabase-realtime`, `seo`)
+- confirm install step
+- normalizes project directory name into a safe project slug for generated `package.json` and env placeholders
+
+### Non-interactive create options (for CI/automation)
+
+- `--yes`: skip prompts and use defaults
+- `--package-manager <npm|pnpm|yarn|bun>`: set package manager explicitly
+- `--module <id...>`: preselect optional modules (repeat or comma-separated)
+- `--install` / `--no-install`: force install behavior
+
+```bash
+node dist/cli.js create my-nextjs-app --yes --module supabase --module seo --no-install
+```
+
+## Core auth in base template
+
+Generated projects now include:
+- Better Auth + Prisma adapter with JWT plugin enabled
+- email/password sign-in scaffold (`/sign-in`)
+- account sample page (`/account`)
+- auth API wrappers:
+  - `POST /api/v1/auth/login`
+  - `POST /api/v1/auth/refresh`
+  - `POST /api/v1/auth/logout`
+  - `GET /api/v1/auth/me`
+
+Axios setup is split:
+- `publicApi`: public calls
+- `protectedApi`: bearer token calls with 401 refresh queue + retry
+- refresh uses HttpOnly cookie strategy (`withCredentials: true`)
+
+## API response standard
+
+Project-owned routes under `/api/v1/*` use a unified envelope:
+
+- Success:
+  - `{ success: true, data: T, meta: { timestamp, requestId?, pagination? } }`
+- Error:
+  - `{ success: false, error: { code, message, details? }, timestamp, requestId? }`
+
+This is powered by `src/lib/api-response.ts` in generated apps.
+The Better Auth passthrough route `/api/auth/[...all]` remains unwrapped.
+
+## Command: add feature
+
+Run inside a generated project root:
+
+```bash
+node ../dist/cli.js add feature orders
+```
+
+`add feature` now always creates:
+- `src/features/<feature>/api/use-<feature>.ts`
+- `src/features/<feature>/components/`
+- `src/features/<feature>/services.ts`
+- `src/features/<feature>/validations.ts`
+- `src/app/api/v1/<feature>/route.ts`
+
+## Command: add module
+
+Add optional modules after project initialization:
+
+```bash
+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`
+- `supabase-realtime`
+- `seo`
+
+Non-interactive example:
+
+```bash
+node ../dist/cli.js add module --module seo --module supabase --yes
+```
+
+## Command: add auth-provider
+
+Enable social auth providers after project creation (not created by default):
+
+```bash
+node ../dist/cli.js add auth-provider
+```
+
+Supported providers:
+- `google`
+- `facebook`
+
+Non-interactive example:
+
+```bash
+node ../dist/cli.js add auth-provider --provider google --provider facebook --yes
+```
+
+This command:
+- updates `src/lib/auth.ts` provider block
+- merges provider env keys into `.env` and `.env.example`
+- 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:
+
+```bash
+node ../dist/cli.js migrate
+```
+
+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
+
+- Next.js App Router + TypeScript
+- Better Auth + Prisma adapter
+- 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, supabase-realtime, seo
+
+## Template structure
+
+Base template lives in:
+
+- `templates/next-base`
+
+Optional module templates:
+
+- `templates/features/chat`
+- `templates/features/supabase`
+- `templates/features/supabase-realtime`
+- `templates/features/seo`
+
+## Realtime chat schema foundation
+
+Chatbox Prisma entities are appended only when you add the `chat` module
+(`create --module chat` or `add module --module chat`).
+
+When chat is selected, NexTCLI auto-adds `supabase-realtime` if missing.
+
+The generated chat schema is provider-agnostic so you can plug in Supabase Realtime,
+WebSocket, Pusher, or any transport later without redesigning data:
+
+- `ChatConversation`
+- `ChatParticipant`
+- `ChatMessage`
+
+Core relations and constraints are included:
+
+- participant uniqueness per conversation (`conversationId`, `userId`)
+- ordered message lookup index (`conversationId`, `createdAt`)
+- sender and participant linkage to `User`

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }