@thinhnguyencth1204/nextcli 0.6.1 → 0.8.0

package/templates/next-base/PROJECT_STRUCTURE.md

@@ -1,6 +1,6 @@
 # Project structure
 
-Generated by NexTCLI. Folders marked **(module)** or **(feature)** appear only when that add-on is enabled.
+Generated by NexTCLI. Folders marked **(module)** appear only when that add-on is enabled.
 
 ## Root
 
@@ -9,22 +9,16 @@ Generated by NexTCLI. Folders marked **(module)** or **(feature)** appear only w
 | `nextcli.json`         | Manifest: CLI version, locales, namespaces, modules, features |
 | `SETUP.md`             | Env + branding setup (this repo)                              |
 | `PROJECT_STRUCTURE.md` | Folder map (this file)                                        |
-| `prisma/`              | Schema + migrations                                           |
-| `messages/`            | i18n JSON per locale/namespace                                |
 | `public/`              | Static assets (`logo.svg`, etc.)                              |
 
-## `src/app/` — App Router
+## `src/app/` — App Router (base)
 
-| Path                 | Purpose                                    |
-| -------------------- | ------------------------------------------ |
-| `layout.tsx`         | Root layout, metadata from `branding`      |
-| `globals.css`        | Design tokens (`nextcli:theme` markers)    |
-| `(auth)/`            | Sign-in, forced password change            |
-| `(dashboard)/`       | Protected shell (session + password guard) |
-| `api/auth/[...all]/` | Better Auth passthrough (not wrapped)      |
-| `api/v1/`            | Project API envelope (`ok` / `fail`)       |
-| `api/v1/users/`      | User CRUD + RBAC **(base)**                |
-| `api/v1/example/`    | Demo CRUD sample                           |
+| Path          | Purpose                                 |
+| ------------- | --------------------------------------- |
+| `layout.tsx`  | Root layout, metadata from `branding`   |
+| `page.tsx`    | Welcome landing page                    |
+| `blog-demo/`  | Rich text create/edit/read demo         |
+| `globals.css` | Design tokens (`nextcli:theme` markers) |
 
 ## `src/config/`
 
@@ -32,56 +26,51 @@ Generated by NexTCLI. Folders marked **(module)** or **(feature)** appear only w
 | ------------- | ------------------------------------ |
 | `branding.ts` | Project name, logo path, description |
 
-## `src/lib/` — Shared runtime
-
-| Path                         | Purpose                                                         |
-| ---------------------------- | --------------------------------------------------------------- |
-| `auth.ts` / `auth-client.ts` | Better Auth (username + JWT)                                    |
-| `bootstrap.ts`               | Seeds `admin` role/user on startup                              |
-| `rbac.ts`                    | Role hierarchy guards                                           |
-| `prisma.ts`                  | DB client                                                       |
-| `api-response.ts`            | `/api/v1/*` envelope helpers                                    |
-| `supabase/`                  | Supabase client + Storage helpers                               |
-| `email/`                     | **(module: `email`)** provider-agnostic email helper + adapters |
-
-## `src/features/` vs `src/example/`
-
-| Path               | Purpose                                                   |
-| ------------------ | --------------------------------------------------------- |
-| `features/auth/`   | Sign-in + change-password UI                              |
-| `features/users/`  | User validations/services for API                         |
-| `example/`         | Starter demo feature (rename for production)              |
-| `features/<name>/` | **(feature: `nextcli add feature <name>`)** CRUD scaffold |
-
 ## `src/components/`
 
-| Path                | Purpose                           |
-| ------------------- | --------------------------------- |
-| `branding/logo.tsx` | Logo + project name               |
-| `layout/private/`   | Dashboard shell (sidebar, header) |
-| `ui/`               | shadcn-style primitives           |
+| Path                | Purpose                                 |
+| ------------------- | --------------------------------------- |
+| `branding/logo.tsx` | Logo + project name                     |
+| `rich-text/`        | Lexical editor adapters, renderer, demo |
+| `ui/`               | shadcn-style primitives                 |
+| `providers/`        | Theme provider                          |
 
-## `src/i18n/`
+## `src/lib/rich-text/` (base)
 
-Locale config with `nextcli:locales` / `nextcli:namespaces` markers (patched by `nextcli add language` / `add feature`).
+| Path                       | Purpose                                              |
+| -------------------------- | ---------------------------------------------------- |
+| `image-urls.ts`            | Extract image URLs from Lexical JSON                 |
+| `supabase-url.ts`          | Map Supabase public URLs to storage paths            |
+| `sync-removed-images.ts`   | Lifecycle helper for removed images                  |
+| `default-image-removal.ts` | No-op remover (swap when `supabase` module is added) |
 
-## `src/emails/`
+## Optional modules (via `nextcli add module`)
 
-**(module: `email`)** React Email templates.
+| Module              | Adds                                                                  |
+| ------------------- | --------------------------------------------------------------------- |
+| `database`          | Prisma schema, client, `DATABASE_URL`, db scripts                     |
+| `supabase`          | Supabase browser client + Storage helpers + `rich-text-image-sync.ts` |
+| `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                           |
+| `dashboard`         | Protected dashboard shell, sidebar, data-table UI                     |
+| `example`           | Starter CRUD demo feature + `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`             | `src/lib/email/*`, `src/emails/*` (provider: SMTP or Resend)          |
 
-## Optional modules (via `nextcli add module`)
+Module **env variables** and where to find them: see `SETUP.md` → **Optional module environment**.
+
+## Generated features
 
-| Module              | Adds                                                                |
-| ------------------- | ------------------------------------------------------------------- |
-| `chat`              | Chat routes, hooks, Prisma chat models (+ auto `supabase-realtime`) |
-| `supabase-realtime` | Realtime channel helpers                                            |
-| `seo`               | robots/sitemap/JSON-LD helpers                                      |
-| `email`             | `src/lib/email/*`, `src/emails/*` (provider: SMTP or Resend)        |
+| Path               | Purpose                                                   |
+| ------------------ | --------------------------------------------------------- |
+| `features/<name>/` | **(feature: `nextcli add feature <name>`)** CRUD scaffold |
 
-Module **env variables** and where to find them: see `SETUP.md` → **Optional module environment** (full catalog; `Enabled modules` line updates when you create/add modules).
+Requires `database` and `api` modules in the project.
 
 ## Notes
 
+- Review `prisma/schema.prisma` before production migrations when `database` is enabled.
 - Do not wrap `api/auth/[...all]` responses — Better Auth expects raw format.
-- Review `prisma/schema.prisma` before production migrations (demo `Example` model).
-- Super-admin account `admin` cannot be modified/deleted via user APIs.

package/templates/next-base/SETUP.md

@@ -2,13 +2,16 @@
 
 Quick reference for env vars and branding after `nextcli create`.
 
-## First run (required)
+## Minimal base project
 
-1. Create a Supabase project and set `DATABASE_URL` and `DIRECT_URL` in `.env`.
-2. `bun run db:migrate` — applies `prisma/migrations` (includes `Role`, `User.username`, `requirePasswordChange`).
-3. `bun run dev` — bootstrap seeds `admin` / `admin` on first start.
+The default template ships a lightweight Next.js shell with branding, theme, and UI primitives only. No database, auth, or dashboard code is included until you select modules at create time or run `nextcli add module`.
 
-`postinstall` runs `prisma generate` so TypeScript knows models like `Role` and `requirePasswordChange`. If types look stale, run `bun run db:generate` manually.
+## First run
+
+1. `bun run dev` (or your package manager equivalent)
+2. Open `http://localhost:3000`
+
+When you add the `database` module, run `bun run db:migrate` before relying on Prisma models.
 
 ## Branding (edit in repo, not env)
 
@@ -17,26 +20,14 @@ Quick reference for env vars and branding after `nextcli create`.
 | Display name, slug, description, logo path | `src/config/branding.ts`                                                  |
 | Logo file                                  | `public/logo.svg` (or update `logoPath`)                                  |
 | Theme colors (primary, sidebar, …)         | `src/app/globals.css` between `nextcli:theme:start` / `nextcli:theme:end` |
-| Sidebar/header labels (i18n)               | `messages/<locale>/common.json` → `appName`                               |
 
 ## Core environment variables
 
-Set in `.env` / `.env.development` (secrets are generated at create time).
-
-| Variable                              | Purpose                                                                               | Where to get                                                                           |
-| ------------------------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `DATABASE_URL`                        | Postgres URL for app runtime and Prisma CLI (`prisma.config.ts` → `datasource.url`)   | Supabase Dashboard → Connect → ORMs → Prisma → pooled URL (`:6543`, `?pgbouncer=true`) |
-| `DIRECT_URL`                          | Direct/session Postgres URL from Supabase Connect (keep in env for reference/tooling) | Supabase Dashboard → Connect → ORMs → Prisma → direct/session URL (`:5432`)            |
-| `NEXT_PUBLIC_SUPABASE_URL`            | Supabase client URL                                                                   | Supabase Dashboard → Project Settings → API → Project URL                              |
-| `NEXT_PUBLIC_SUPABASE_ANON_KEY`       | Browser-safe anon API key (public key used by client SDK)                             | Same page → Project API keys → `anon` `public`                                         |
-| `NEXT_PUBLIC_SUPABASE_STORAGE_BUCKET` | Storage bucket name used by app uploads/reads (`public` is the default bucket name)   | Storage → create/select bucket → use that bucket name                                  |
-| `BETTER_AUTH_SECRET`                  | Auth signing secret                                                                   | Auto-generated on create; rotate in production                                         |
-| `BETTER_AUTH_URL`                     | Server auth base URL                                                                  | Your app URL (e.g. `http://localhost:3000`)                                            |
-| `NEXT_PUBLIC_APP_URL`                 | Client-visible app URL                                                                | Same as public site URL                                                                |
+Set in `.env` / `.env.development`.
 
-### Default admin account
-
-On first `dev` / `start`, bootstrap creates role `admin` and user `admin` / `admin` (must change password on first login).
+| Variable              | Purpose                | Where to get                          |
+| --------------------- | ---------------------- | ------------------------------------- |
+| `NEXT_PUBLIC_APP_URL` | Client-visible app URL | Your public site URL (e.g. localhost) |
 
 ## Optional module environment
 
@@ -50,45 +41,6 @@ Reference for all optional modules. Matching keys are merged into `.env` when se
 
 <!-- nextcli:module-env:start -->
 
-### Module: Chat module (`chat`)
-
-| Variable                  | Where to get                                         |
-| ------------------------- | ---------------------------------------------------- |
-| `NEXT_PUBLIC_ENABLE_CHAT` | Set `true` when chat module is enabled (auto on add) |
-
-Requires `supabase-realtime` (auto-added). Run `db:migrate` after add — chat Prisma models are appended.
-
-### Module: Supabase Realtime (`supabase-realtime`)
-
-Uses the base Supabase URL/anon key. Enable Realtime on tables in Supabase Dashboard → Database → Replication.
-
-### Module: SEO pack (`seo`)
-
-No extra env keys. Edit `src/app/robots.ts`, `sitemap.ts`, and JSON-LD helpers after add.
-
-### Module: Email module (`email`)
-
-| Variable         | Where to get       |
-| ---------------- | ------------------ |
-| `EMAIL_PROVIDER` | `resend` or `smtp` |
-
-When `EMAIL_PROVIDER=resend`:
-
-| Variable            | Where to get                                                       |
-| ------------------- | ------------------------------------------------------------------ |
-| `RESEND_API_KEY`    | resend.com → API Keys → Create                                     |
-| `RESEND_FROM_EMAIL` | resend.com → Domains → verify domain → use `Name <you@domain.com>` |
-
-When `EMAIL_PROVIDER=smtp`:
-
-| Variable        | Where to get                                 |
-| --------------- | -------------------------------------------- |
-| `SMTP_HOST`     | SMTP provider host (Mailgun, SES, etc.)      |
-| `SMTP_PORT`     | SMTP provider port (commonly `587` or `465`) |
-| `SMTP_USER`     | SMTP username                                |
-| `SMTP_PASSWORD` | SMTP password or app-specific token          |
-| `SMTP_FROM`     | Sender email (or `Name <mail@domain.com>`)   |
-
 <!-- nextcli:module-env:end -->
 
 ## After adding modules