@betterstart/cli 0.1.41 → 0.1.43

package/README.md

@@ -1,260 +1,3 @@
 # @betterstart/cli
 
-> **Warning:** This project is a work in progress. Expect bugs, breaking changes, and incomplete features.
-
-Drop a production-ready CMS into any Next.js 16 app with one command. You get a full admin panel — auth, CRUD, rich text editing, file uploads, forms — living in a self-contained `cms/` directory. You own the code. No vendor lock-in.
-
-```bash
-npx @betterstart/cli init
-```
-
-## What you get
-
-- **Admin panel** with sidebar navigation, search, filters, bulk actions, and CSV export
-- **Authentication** via Better Auth (email/password, role-based: admin, editor, member)
-- **22 field types** including rich text (TipTap), markdown (CodeMirror + Shiki), image/video uploads, relationships, tabs, groups, lists, and curriculum builder
-- **Public forms** with multi-step support, email notifications, Mailchimp integration, and a submissions admin
-- **Three schema types** — entities (full CRUD), singles (settings pages), and forms (public-facing with submission tracking)
-- **Caching** with Next.js 16 `'use cache'` directive, `cacheLife`, `cacheTag`, and `updateTag`
-
-## Commands
-
-### `betterstart init [name]`
-
-Scaffold the CMS into a new or existing Next.js project.
-
-```bash
-betterstart init                       # Interactive setup in current project
-betterstart init my-app                # Create new Next.js app + CMS
-betterstart init --preset blog -y      # Non-interactive with blog preset
-```
-
-**Presets:**
-
-| Preset | What it includes |
-|--------|-----------------|
-| `blank` | Settings singleton only |
-| `blog` | Settings + Categories + Posts (with many-to-many) |
-| `full` | Blog + Navigation + Contact form |
-
-Init runs 12 scaffolders in sequence: base directories, tsconfig aliases, Tailwind tokens, env vars, database, auth, UI components (206 files), layouts, API routes, linter config, dependency installation (~130 packages), and preset generation.
-
-### `betterstart generate <schema>`
-
-Generate everything from a JSON schema file in `cms/schemas/`.
-
-```bash
-betterstart generate posts                # Entity CRUD (12 files)
-betterstart generate settings             # Single-type page (7 files)
-betterstart generate contact              # Form + admin (14 files)
-betterstart generate posts --force        # Overwrite existing files
-betterstart generate posts --skip-migration  # Skip drizzle-kit push
-```
-
-Schema type is auto-detected: files in `schemas/forms/` or with `submitButtonText`/`steps` are forms, `type: "single"` is a single, everything else is an entity.
-
-### `betterstart remove <schema>`
-
-Remove all generated files for a schema and clean up `schema.ts` + `navigation.ts`.
-
-```bash
-betterstart remove posts
-```
-
-### `betterstart seed`
-
-Create an initial admin user interactively.
-
-```bash
-betterstart seed
-```
-
-### `betterstart setup-r2`
-
-Configure Cloudflare R2 for file uploads.
-
-### `betterstart update-deps`
-
-Install or update all CMS dependencies to their latest versions.
-
-### `betterstart update-styles`
-
-Replace `cms-globals.css` with the latest version from the CLI templates.
-
-## Generated file structure
-
-```
-cms/
-  db/schema.ts                 # Drizzle table definitions
-  lib/actions/<name>.ts        # Server actions (CRUD, search, filter, export)
-  lib/cache/                   # Cache tags, cached queries, revalidation
-  hooks/use-<name>.ts          # React Query hooks
-  components/forms/            # Public form components
-  lib/emails/                  # React Email notification templates
-  data/navigation.ts           # Sidebar navigation config
-
-app/(cms)/cms/(authenticated)/
-  <entity>/
-    page.tsx                   # Server page with Suspense
-    columns.tsx                # TanStack Table column definitions
-    <name>-table.tsx           # Data table with pagination + sorting
-    page-content.tsx           # Client component (search, filters, bulk actions)
-    <name>-form.tsx            # Create/edit form with Zod validation
-    new/page.tsx               # Create page
-    [id]/edit/page.tsx         # Edit page
-  forms/<form>/
-    page.tsx                   # Submissions list
-    [id]/page.tsx              # View submission
-    settings/page.tsx          # Notification + export settings
-```
-
-## Schema examples
-
-### Entity
-
-```json
-{
-  "name": "posts",
-  "label": "Blog Posts",
-  "icon": "FileText",
-  "navGroup": { "label": "Blog", "icon": "BookOpen" },
-  "fields": [
-    { "name": "title", "type": "string", "label": "Title", "required": true },
-    { "name": "slug", "type": "string", "label": "Slug", "hidden": true },
-    { "name": "content", "type": "richtext", "label": "Content", "output": "html" },
-    { "name": "image", "type": "image", "label": "Featured Image" },
-    { "name": "published", "type": "boolean", "label": "Published" },
-    {
-      "name": "categories",
-      "type": "relationship",
-      "relationship": "categories",
-      "label": "Categories",
-      "multiple": true
-    }
-  ],
-  "columns": [
-    { "accessorKey": "title", "header": "Title", "type": "text", "sortable": true },
-    { "accessorKey": "published", "header": "Status", "type": "badge" }
-  ],
-  "actions": { "create": true, "edit": true, "delete": true, "draft": true },
-  "search": { "fields": ["title"] },
-  "autoSlugify": { "enabled": true, "sourceField": "title", "targetField": "slug" }
-}
-```
-
-### Single
-
-```json
-{
-  "name": "settings",
-  "type": "single",
-  "label": "Settings",
-  "icon": "Settings",
-  "fields": [
-    { "name": "siteName", "type": "string", "label": "Site Name" },
-    { "name": "description", "type": "text", "label": "Description" }
-  ]
-}
-```
-
-### Form (multi-step)
-
-```json
-{
-  "name": "candidateApplication",
-  "label": "Candidate Applications",
-  "icon": "UserPlus",
-  "submitButtonText": "Submit Application",
-  "successMessage": "Thanks for applying!",
-  "notificationEmail": "hr@example.com",
-  "steps": [
-    {
-      "name": "basicInfo",
-      "label": "Basic Information",
-      "fields": [
-        { "name": "name", "type": "text", "label": "Full Name", "required": true },
-        { "name": "email", "type": "email", "label": "Email", "required": true }
-      ]
-    },
-    {
-      "name": "experience",
-      "label": "Experience",
-      "fields": [
-        { "name": "resume", "type": "upload", "label": "Resume" }
-      ]
-    }
-  ]
-}
-```
-
-## Field types
-
-### Entity/Single (22 types)
-
-| Category | Types |
-|----------|-------|
-| Text | `string`, `text`, `varchar` |
-| Rich content | `richtext`, `markdown` |
-| Numbers | `number`, `decimal`, `serial` |
-| Date/time | `date`, `timestamp`, `time` |
-| Boolean | `boolean` |
-| Media | `image`, `video`, `media`, `icon` |
-| Selection | `select`, `relationship` |
-| Layout | `group`, `tabs`, `separator` |
-| Complex | `list`, `curriculum` |
-
-### Form (17 types)
-
-`text`, `textarea`, `email`, `phone`, `number`, `url`, `date`, `select`, `radio`, `checkbox`, `multiselect`, `file`, `upload`, `group`, `list`, `timezone`, `dynamicFields`
-
-## Tech stack
-
-| Concern | Technology |
-|---------|-----------|
-| Framework | Next.js 16 (App Router) |
-| Database | Drizzle ORM + Neon PostgreSQL |
-| Auth | Better Auth |
-| UI | Radix primitives + Tailwind CSS v4 |
-| Rich text | TipTap |
-| Markdown | CodeMirror + Shiki + KaTeX |
-| Tables | TanStack React Table |
-| Data fetching | TanStack React Query |
-| Forms | React Hook Form + Zod |
-| URL state | nuqs |
-| Storage | Cloudflare R2 |
-| Email | Resend + React Email (opt-in) |
-| Icons | Lucide React |
-
-## Configuration
-
-Create `cms.config.ts` in your project root (generated by `init`):
-
-```typescript
-import { defineConfig } from '@betterstart/cli'
-
-export default defineConfig({
-  database: {
-    provider: 'neon',
-  },
-  features: {
-    email: true,
-  },
-})
-```
-
-All generated code uses `@cms/*` path aliases:
-
-```typescript
-import { db } from '@cms/db'
-import { posts } from '@cms/db/schema'
-import { getPosts } from '@cms/actions/posts'
-```
-
-## Requirements
-
-- Node.js >= 22
-- Next.js 16 with TypeScript and Tailwind CSS v4
-
-## License
-
-MIT
+> **Warning:** This project is a work in progress. Expect bugs, breaking changes, and incomplete features.