modern-cms 1.1.3 → 1.1.4

package/README.md

@@ -25,11 +25,29 @@ A self-hosted, drag-and-drop website CMS: a Next.js (App Router) front end, an E
 
 ## Installation
 
+**npx (no install — always runs the latest version):**
+
 ```bash
 npx modern-cms
 ```
 
-(No global install needed — `npx` fetches and runs the latest version each time. If you prefer a global install: `npm install -g modern-cms && modern-cms`.)
+**npm (global install):**
+
+```bash
+npm install -g modern-cms
+modern-cms
+```
+
+**yarn:**
+
+```bash
+# Yarn Classic (v1)
+yarn global add modern-cms
+modern-cms
+
+# Yarn Berry (v2+)
+yarn dlx modern-cms
+```
 
 ### What the installer asks
 
@@ -66,6 +84,10 @@ npm run dev
 
 Then open the web app at the URL you chose (default `http://localhost:3000`) and log in at `/admin` with the admin email/password from the wizard.
 
+> **Prefer yarn for the scaffolded project too?** `yarn install` works fine, and `dev`/`db:migrate`/`db:seed` all run correctly (they use `tsx`, which doesn't type-check). The one caveat: yarn's dependency hoisting can occasionally produce a duplicate `@types/express`, which shows up as spurious TypeScript errors only if you run `npm run build` or `tsc` directly — running `npm install` once resolves it.
+>
+> **Logged in with the wrong password?** The admin user is only created the *first* time `db:seed` runs — editing `.env` afterward doesn't retroactively change it. Run `npm run db:reset-admin && npm run db:seed` to delete and recreate it from the current `.env` values.
+
 ## Project layout
 
 The scaffolded project is an npm-workspaces monorepo:

package/bin/modern-cms.js

@@ -18,11 +18,17 @@ import {
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const TEMPLATE_DIR = path.join(__dirname, "..", "template");
 
+// npm's packlist strips any file literally named ".gitignore" out of the published
+// tarball, so the template ships it as "gitignore" — restore the leading dot on scaffold.
+function destName(name) {
+  return name === "gitignore" ? ".gitignore" : name;
+}
+
 function copyDir(src, dest) {
   fs.mkdirSync(dest, { recursive: true });
   for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
     const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
+    const destPath = path.join(dest, destName(entry.name));
     if (entry.isDirectory()) copyDir(srcPath, destPath);
     else fs.copyFileSync(srcPath, destPath);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modern-cms",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Self-hosted, drag-and-drop website CMS (Next.js + Express + Prisma). Interactive installer scaffolds a full project with your choice of PostgreSQL/MySQL and AWS S3/Azure Blob/Cloudinary storage.",
   "type": "module",
   "bin": {

package/template/README.md

@@ -12,14 +12,68 @@ Built as an npm-workspaces monorepo:
 
 ---
 
-## Quick start
+## Installation
 
-### Prerequisites
+There are two ways to get a working project: install the published `modern-cms` package (fastest — an interactive wizard scaffolds everything and writes your `.env` files), or clone this repository directly (for contributing to pg-cms itself). Most people want the first one.
+
+### Option A — Install the `modern-cms` package (recommended)
+
+Works with npx, npm, or yarn — pick whichever you already use.
+
+**npx (no install — always runs the latest version):**
+
+```bash
+npx modern-cms
+```
+
+**npm (global install, then run anytime with just `modern-cms`):**
+
+```bash
+npm install -g modern-cms
+modern-cms
+```
+
+**yarn:**
+
+```bash
+# Yarn Classic (v1)
+yarn global add modern-cms
+modern-cms
+
+# Yarn Berry (v2+) — no global install needed
+yarn dlx modern-cms
+```
+
+The wizard asks for your database (PostgreSQL or MySQL, with host/port/name/username/password), the web app port and API port, your file storage provider (AWS S3, Azure Blob Storage, or Cloudinary, with that provider's credentials), and an admin email/password — then scaffolds a full project and writes working `.env` files. It never runs `npm install`, touches your database, or starts anything by itself; it prints the exact next commands.
+
+```bash
+cd <your-project-dir>
+
+# npm (recommended — see the yarn note below):
+npm install
+npm run db:migrate          # PostgreSQL
+# MySQL installs use schema-push instead, since the bundled migration
+# history is Postgres-specific SQL:
+# npx prisma generate --schema apps/api/prisma/schema.prisma
+# npx prisma db push --schema apps/api/prisma/schema.prisma
+npm run db:seed
+npm run dev
+```
+
+> **Using yarn to install the scaffolded project itself?** `yarn install` works fine, and `npm run dev` / `db:migrate` / `db:seed` all run correctly under a yarn-installed `node_modules` (they invoke `tsx`, which doesn't type-check). The one thing to watch for: yarn's dependency hoisting can occasionally produce a duplicate `@types/express` in the tree, which shows up as spurious TypeScript errors *only* if you run `npm run build` or `tsc` directly. If that happens, running `npm install` once (even alongside your yarn workflow) resolves it — that's yarn's hoisting, not a bug in the project.
+
+See [`packages/modern-cms/README.md`](packages/modern-cms/README.md) for the full prompt-by-prompt reference and configuration details.
+
+### Option B — Clone this repository
+
+For working on pg-cms itself, not for building a site with it.
+
+#### Prerequisites
 
 - Node.js 18+
 - Docker Desktop (for PostgreSQL + MinIO)
 
-### 1. Start the databases
+#### 1. Start the databases
 
 ```bash
 npm run docker:up
@@ -37,7 +91,7 @@ A one-shot init container creates the `pgcms-media` bucket automatically.
 
 > **Port conflicts:** if `docker compose up` fails with "port is already allocated", another container or service owns that port — run `docker ps` to find it, then either stop it or change the host-side port in `docker-compose.yml` **and** the matching URLs in `apps/api/.env`.
 
-### 2. Environment files
+#### 2. Environment files
 
 Two env files are used:
 
@@ -53,7 +107,7 @@ cp .env.example apps/api/.env   # then trim to the API-relevant keys, or keep al
 
 **Important:** the password inside `DATABASE_URL` in `apps/api/.env` must match `POSTGRES_PASSWORD` in the root `.env`. Postgres sets its password the *first* time its data volume is created — changing `.env` later does not change the database password.
 
-### 3. Install, migrate, seed
+#### 3. Install, migrate, seed
 
 ```bash
 npm install
@@ -69,7 +123,7 @@ npx tsx prisma/seed-homepage.ts
 npx tsx prisma/seed-our-charities.ts
 ```
 
-### 4. Run the dev servers
+#### 4. Run the dev servers
 
 ```bash
 npm run dev            # API (port 4000) + web (port 3000) together
@@ -78,7 +132,7 @@ npm run dev:api
 npm run dev:web
 ```
 
-### 5. Log in
+#### 5. Log in
 
 | URL | What |
 |---|---|
@@ -161,6 +215,7 @@ Six scene presets usable in the Hero or the dedicated 3D Background component: *
 | `npm run docker:up` / `npm run docker:down` | Start / stop Postgres + MinIO |
 | `npm run db:migrate` | Apply Prisma migrations (`prisma migrate dev`) |
 | `npm run db:seed` | Seed admin user, theme, sample page |
+| `npm run db:reset-admin` | Delete the admin user matching `SEED_ADMIN_EMAIL` so the next `db:seed` recreates it (e.g. after changing the seed password) |
 
 ---
 
@@ -202,9 +257,9 @@ No builder-chrome changes needed — the palette, inspector, and drag-and-drop p
 
 **`port is already allocated` from Docker** — another container owns the host port. `docker ps`, then stop it or change the port mapping in `docker-compose.yml` + the URLs in `apps/api/.env`.
 
-**"Invalid email or password"** — credentials are case-sensitive; watch for browser autofill inserting a stale saved password. The current values live in `apps/api/.env`.
+**"Invalid email or password"** — credentials are case-sensitive; watch for browser autofill inserting a stale saved password. The current values live in `apps/api/.env` (`SEED_ADMIN_EMAIL` / `SEED_ADMIN_PASSWORD`, used only the *first* time `db:seed` creates that user — editing `.env` afterward doesn't change an already-created password). If you scaffolded the project with `modern-cms` before v1.1.3 and your password contains `#`, it was silently truncated by `dotenv`'s comment parsing (fixed in 1.1.3 — update and rescaffold, or run `npm run db:reset-admin && npm run db:seed` to delete and recreate the existing admin user from the current `.env` values, without rescaffolding).
 
 **Prisma `EPERM ... query_engine ... .dll.node` on Windows** — the running API dev server is holding the engine file. Stop it (`netstat -ano | findstr :4000`, then kill that PID), run the migration, restart.
 
 **Dev server "running" but serving stale code** — an orphaned process may still own the port. Verify with `netstat -ano | findstr :3000` (or `:4000`) and kill the listed PID before restarting.
-"# Modern-CMS" 
+

package/template/apps/api/package.json

@@ -11,7 +11,8 @@
     "db:generate": "prisma generate",
     "db:seed": "tsx prisma/seed.ts",
     "db:seed:demo-charities": "tsx prisma/seed-our-charities.ts",
-    "db:seed:templates": "tsx prisma/seed-templates.ts"
+    "db:seed:templates": "tsx prisma/seed-templates.ts",
+    "db:reset-admin": "tsx prisma/reset-admin.ts"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.665.0",

package/template/apps/api/prisma/reset-admin.ts

@@ -3,10 +3,18 @@ import { PrismaClient } from "@prisma/client";
 
 const prisma = new PrismaClient();
 
+// Matches whatever seed.ts actually used to create the user — a hardcoded fallback
+// here would silently no-op for anyone who set a custom SEED_ADMIN_EMAIL (which the
+// modern-cms installer always prompts for).
 async function main() {
-  const email = "admin@example.com";
-  await prisma.user.deleteMany({ where: { email } });
-  console.log("Deleted existing admin user");
+  const email = process.env.SEED_ADMIN_EMAIL ?? "admin@example.com";
+  const { count } = await prisma.user.deleteMany({ where: { email } });
+  if (count === 0) {
+    console.log(`No user found for ${email} — nothing to delete.`);
+  } else {
+    console.log(`Deleted existing admin user: ${email}`);
+  }
+  console.log('Run "npm run db:seed" (from the repo root) to recreate it with the current SEED_ADMIN_EMAIL/SEED_ADMIN_PASSWORD in .env.');
 }
 
 main()

package/template/gitignore

@@ -0,0 +1,9 @@
+node_modules/
+dist/
+.next/
+.env
+.env.local
+*.log
+.DS_Store
+minio-data/
+postgres-data/

package/template/package.json

@@ -18,7 +18,8 @@
     "docker:up": "docker compose up -d",
     "docker:down": "docker compose down",
     "db:migrate": "npm run db:migrate -w apps/api",
-    "db:seed": "npm run db:seed -w apps/api"
+    "db:seed": "npm run db:seed -w apps/api",
+    "db:reset-admin": "npm run db:reset-admin -w apps/api"
   },
   "devDependencies": {
     "@types/react": "^19.2.17",

package/template/tsconfig.base.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "declaration": false
+  }
+}