@infuro/cms-core 1.0.6 → 1.0.8

package/README.md

@@ -4,56 +4,40 @@ A headless CMS framework built on Next.js and TypeORM. It provides a ready-to-us
 
 ## Overview
 
-**What you need to set up a new site:**
+You don't set up or clone core in each website. Install the published package and run the init command to scaffold a new site.
 
-- Next.js 14+ app with TypeScript and Tailwind
-- PostgreSQL and env vars: `DATABASE_URL`, `NEXTAUTH_SECRET`, `NEXTAUTH_URL`
-- A few files in your app: **data-source** (TypeORM), **auth-helpers**, **cms** (plugins), **API catch-all route**, **NextAuth route**, **admin layout + catch-all page**, **middleware**, **providers** (Session + Theme + Toaster)
-- Tailwind config that includes the package in `content` and extends theme (shadcn-style colors)
-- Optional: custom admin nav, custom CRUD configs, custom admin pages, plugins
+**Typical workflow for a new site:**
 
-**Install from npm:**
+1. Create a Next.js app (TypeScript, Tailwind, App Router, `src` directory):  
+   `npx create-next-app@latest my-site --typescript --tailwind --app --src-dir`
+2. From the project root, run:  
+   `npx @infuro/cms-core init`
+3. Copy `.env.example` to `.env`, set `DATABASE_URL`, `NEXTAUTH_SECRET`, `NEXTAUTH_URL`, then run `npm run seed` (or migrations) and `npm run dev`.
 
-```bash
-npm install @infuro/cms-core typeorm reflect-metadata bcryptjs next-auth next-themes sonner
-npm install -D @types/node
-```
+Init creates all required files (data-source, auth-helpers, cms, API routes, admin layout and page, middleware, providers, seed, migration runner, default theme, basic home and contact pages), and can patch `next.config`, `tailwind.config`, layout, and `package.json` and install dependencies. Use `--force` to overwrite existing files, `--dry-run` to see what would be created, `--no-deps` to skip npm install, `--no-patch-config` to skip config changes.
 
-For local development with the core package in a sibling folder:
+**Manual setup (if you prefer not to use init):** Install from npm (`npm install @infuro/cms-core typeorm reflect-metadata bcryptjs next-auth next-themes sonner` and `npm install -D @types/node`), then follow the step-by-step setup below. For local development of core itself, use `"@infuro/cms-core": "file:../core"` in the site's package.json.
 
-```json
-"@infuro/cms-core": "file:../core"
-```
-
-Then follow the setup steps below.
-
-## Architecture
+## Project structure (your site after setup)
 
 ```
-core/                         # This package
-├── src/
-│   ├── entities/             # TypeORM entities (User, Blog, Form, etc.)
-│   ├── api/                  # API handlers (CRUD, auth, CMS-specific)
-│   ├── auth/                 # NextAuth config, middleware, helpers
-│   ├── admin/                # Admin panel (layout, pages, page resolver)
-│   ├── plugins/              # Plugin system (email, storage, analytics, ERP, etc.)
-│   ├── components/           # Shared UI (shadcn/ui + Admin components)
-│   ├── hooks/                # React hooks (analytics, mobile, plugin)
-│   └── lib/                  # Utilities (cn, etc.)
-
-your-website/                 # Your Next.js app
+your-website/
 ├── src/
 │   ├── app/
-│   │   ├── admin/            # 2 files: layout.tsx + [[...slug]]/page.tsx
+│   │   ├── admin/            # layout.tsx + [[...slug]]/page.tsx
 │   │   └── api/
 │   │       ├── auth/         # NextAuth route
-│   │       └── [[...path]]/  # Single catch-all mounting core's API
+│   │       └── [[...path]]/  # Catch-all for CMS API
 │   ├── lib/
-│   │   ├── data-source.ts    # TypeORM DataSource init
-│   │   ├── auth-helpers.ts   # Wire core auth to NextResponse
-│   │   └── cms.ts            # CmsApp init with plugins
-│   ├── middleware.ts          # Wire core middleware to Next.js
-│   └── ...                   # Your custom pages, components, etc.
+│   │   ├── data-source.ts
+│   │   ├── auth-helpers.ts
+│   │   ├── cms.ts
+│   │   ├── theme-registry.ts
+│   │   └── seed.ts
+│   ├── themes/               # Optional: default theme from init
+│   ├── migrations/
+│   ├── middleware.ts
+│   └── ...                   # Your pages, components, etc.
 ```
 
 ## Getting Started
@@ -65,7 +49,7 @@ npx create-next-app@latest my-website --typescript --tailwind --app --src-dir
 cd my-website
 ```
 
-### 2. Install core
+### 2. Install the package
 
 ```bash
 npm install @infuro/cms-core typeorm reflect-metadata bcryptjs next-auth next-themes sonner
@@ -346,7 +330,7 @@ export default async function AdminPage({ params }: { params: Promise<{ slug?: s
 }
 ```
 
-The admin at `/admin` is rendered by core (layout, sidebar, header, built-in pages). Pass `customNavSections` and `customCrudConfigs` to add your own sidebar links and CRUD list pages (see [Adding custom pages and admin nav](#adding-custom-pages-and-admin-nav)).
+The admin at `/admin` is rendered by the package (layout, sidebar, header, built-in pages). Pass `customNavSections` and `customCrudConfigs` to add your own sidebar links and CRUD list pages (see [Adding custom pages and admin nav](#adding-custom-pages-and-admin-nav)).
 
 ### 10. Configure Tailwind
 
@@ -633,13 +617,13 @@ createCmsMiddleware({
 
 ## Tailwind Config
 
-Core's admin panel and UI components use shadcn/ui which requires CSS variable-based color mappings. Your `tailwind.config.js` needs these in `theme.extend.colors`:
+The admin panel and UI components use shadcn/ui and require CSS variable-based color mappings. Your `tailwind.config.js` needs these in `theme.extend.colors`:
 
 ```js
 module.exports = {
   content: [
     "./src/**/*.{js,ts,jsx,tsx,mdx}",
-    "../core/src/**/*.{js,ts,jsx,tsx}",
+    "./node_modules/@infuro/cms-core/dist/**/*.{js,cjs}",
   ],
   darkMode: "class",
   theme: {
@@ -679,7 +663,7 @@ module.exports = {
 };
 ```
 
-The CSS variables themselves are injected by core's AdminLayout at runtime. Your website's own CSS can also define them in `:root` if your public pages use shadcn/ui components.
+The CSS variables are injected by the admin layout at runtime. Your website's own CSS can also define them in `:root` if your public pages use shadcn/ui components.
 
 ## Environment Variables