create-apollo-monorepo 0.9.0 → 0.9.1

package/index.mjs

@@ -399,7 +399,13 @@ function writeRootPackageJson(targetDir, dirName) {
       "cms-plugin:new": "node scripts/new-cms-plugin.mjs",
       lint: "pnpm -r lint",
       typecheck: "pnpm -r typecheck",
-      "backend:update": "git submodule update --remote --merge apps/backend",
+      // Stash any local changes inside the submodule so the fast-forward
+      // merge can't conflict, then update, then run `pnpm install` at the
+      // root so workspace deps pick up any package.json changes pulled in
+      // from the new apollo-cms commit. The stash is restored if it was
+      // created; otherwise this is a no-op.
+      "backend:update":
+        "node -e \"const {execSync:e}=require('child_process');const r=s=>e(s,{stdio:'inherit'});const has=e('git -C apps/backend status --porcelain',{encoding:'utf8'}).trim().length>0;if(has)r('git -C apps/backend stash push -u -m backend-update-auto');r('git submodule update --remote --merge apps/backend');r('pnpm install');if(has){try{r('git -C apps/backend stash pop');}catch(_){console.error('[backend:update] stash pop had conflicts — resolve manually with: git -C apps/backend stash list');}}\"",
       // `pnpm setup` is pnpm's CLI bootstrap built-in — must use `run` to
       // forward to the workspace's setup script (apollo-cms's db:push + db:seed).
       "backend:setup": "pnpm --filter ./apps/backend run setup",
@@ -1383,6 +1389,100 @@ module.exports = {
   writeFileSync(resolve(targetDir, "ecosystem.config.cjs"), config);
 }
 
+function writeClaudeMd(targetDir, adminPrefix) {
+  const singleOrigin = !!adminPrefix;
+  const prefix = adminPrefix || "/admin";
+  const singleOriginSection = singleOrigin
+    ? `## Single-origin routing
+
+Frontend is the public entry point. It rewrites these paths to the backend (do **not** create matching routes in the frontend):
+
+- \`/admin/*\`, \`/uploads/*\`
+- \`/api/auth/*\`, \`/api/v1/*\`, \`/api/email/*\`, \`/api/cron\`, \`/api/health\`, \`/api/mcp\`, \`/api/admin/*\`, \`/api/editing-presence/*\`
+- \`/_next/static\` under \`APOLLO_ASSET_PREFIX=${prefix}\` (backend chunks)
+
+Custom frontend APIs must be namespaced (e.g. \`/api/internal/*\`).
+
+To disable single-origin: remove \`APOLLO_ASSET_PREFIX\` from \`apps/backend/.env.local\` and delete the \`rewrites()\` block in \`apps/frontend/next.config.ts\`.
+
+Known gotcha: backend's \`/_next/image\` is not rewritten — custom admin code using \`<Image>\` on \`/uploads/*\` will 404. Use plain \`<img>\` or \`unoptimized\`.
+`
+    : `## Routing model — separate origins
+
+Frontend and backend run on independent origins. No rewrites; talk to the backend over its public URL.
+`;
+
+  const content = `# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Repo shape
+
+pnpm workspace monorepo. Three workspaces under \`apps/\`:
+
+- \`apps/frontend\` — public Next.js site${singleOrigin ? " (the public origin in single-origin mode)" : ""}.
+- \`apps/backend\` — **git submodule** pointing at \`apollo-cms\`. Treat as read-only; do not edit files in here. Open PRs upstream.
+- \`apps/cms-plugins/<slug>\` — project-specific Apollo CMS plugins. Loaded by the backend via \`APOLLO_EXTRA_PLUGINS_DIR=../cms-plugins\`. Each plugin is built with esbuild to \`dist/server.mjs\` before the backend builds.
+- \`apps/proxy/server.mjs\` — zero-dep Node reverse proxy used for single-origin dev and self-hosted deploys.
+
+Built-in plugins in \`apps/backend/plugins/\` always win on slug collisions with \`apps/cms-plugins/\`.
+
+${singleOriginSection}
+## Common commands
+
+\`\`\`bash
+pnpm install
+pnpm backend:setup          # first-time: db:push + db:seed
+pnpm backend:upgrade        # release-time: db:push + replay src/upgrades/0.1.*.ts + seed
+pnpm backend:update         # fast-forward the apollo-cms submodule
+
+pnpm dev                    # FE + BE + plugin watcher (parallel)
+pnpm dev:rp                 # same + reverse proxy on :3030 (single origin, shared cookies)
+pnpm dev:frontend           # FE only
+pnpm dev:backend            # BE only (runs predev:setup to build plugins first)
+
+pnpm build                  # cms-plugins → backend plugins → backend → frontend
+pnpm build:backend
+pnpm build:frontend
+
+pnpm start                  # FE + BE
+pnpm start:rp               # FE + BE + proxy
+
+pnpm lint                   # recursive
+pnpm typecheck              # recursive
+
+pnpm cms-plugin:new <slug>  # scaffold a new plugin from example-plugin
+\`\`\`
+
+\`pnpm dev\` and \`pnpm build\` both run \`cms-plugins:build\` first (via \`predev:setup\` / build script chain) — plugins must compile to \`dist/server.mjs\` before the backend resolves them in production. In dev under Bun the loader also accepts \`index.ts\` directly.
+
+Release flow on a server: \`pnpm install && pnpm backend:upgrade && pnpm build && pm2 reload all\`. \`pnpm start\` does **not** run migrations.
+
+## Ports
+
+Configured in \`ecosystem.config.cjs\` (PM2) and consumed by \`apps/proxy/server.mjs\` via env:
+
+| Service  | Port |
+| -------- | ---- |
+| proxy    | 3030 |
+| backend  | 3000 |
+| frontend | 3001 |
+
+Proxy reads \`PORT\`, \`BACKEND\`, \`FRONTEND\`, \`ADMIN_PREFIX\` from env. When using the proxy locally, set \`NEXT_PUBLIC_SITE_URL=http://localhost:3030\` so Better Auth / OAuth callbacks land on the unified origin.
+
+## Deploy
+
+- Self-hosted: build on a runner, rsync to the server, then \`pm2 startOrReload ecosystem.config.cjs --update-env\`. If the backend submodule is private, the deploy runner needs a token with read access.
+- Vercel: two projects per repo (\`apps/backend\` and \`apps/frontend\` root dirs). Backend's Build Command must copy \`apps/cms-plugins/*/dist\` into \`apps/backend/plugins/\` before \`next build\` because Turbopack rejects \`outputFileTracingIncludes\` globs above the project root. "Include all submodules" must be ON in both projects.
+
+## Submodule discipline
+
+- Do not edit files under \`apps/backend\` — they belong to the upstream \`apollo-cms\` repo.
+- After \`pnpm backend:update\`, run \`pnpm install\` (in case package.json changed) then \`pnpm backend:upgrade\` (replays data migrations that \`backend:setup\` skips).
+`;
+  writeFileSync(resolve(targetDir, "CLAUDE.md"), content);
+}
+
 function writeReadme(targetDir, dirName, frontendName, adminPrefix) {
   const singleOrigin = !!adminPrefix;
 
@@ -1511,14 +1611,13 @@ folder + \`plugin.json#name\`.
 Apollo CMS is tracked as a git submodule. Full upgrade flow:
 
 \`\`\`bash
-pnpm backend:update    # fast-forward apps/backend to the latest apollo-cms commit
-pnpm install           # in case the submodule changed package.json
+pnpm backend:update    # auto-stash, fast-forward apps/backend, run pnpm install
 pnpm backend:upgrade   # drizzle push + replay version migrations + seed
 \`\`\`
 
 | Script | What it does |
 | --- | --- |
-| \`pnpm backend:update\`  | \`git submodule update --remote --merge apps/backend\` — code only |
+| \`pnpm backend:update\`  | Auto-stashes local submodule changes, fast-forwards \`apps/backend\`, runs \`pnpm install\` so new backend deps are picked up, then restores the stash. |
 | \`pnpm backend:setup\`   | First-time bootstrap: \`db:push\` + \`db:seed\` only |
 | \`pnpm backend:upgrade\` | Full pipeline: \`db:push\` + replay \`src/upgrades/0.1.*.ts\` data migrations + \`db:seed\`. **Use this** after \`backend:update\` — \`backend:setup\` skips the data-migration phase. |
 
@@ -1691,12 +1790,13 @@ async function main() {
   writeRootGitignore(targetDir);
   writeRootEnv(targetDir, { dbUrl, siteUrl, locale, authSecret, cronSecret, adminPrefix, backendInternalUrl });
   writeReadme(targetDir, dirName, frontendName, adminPrefix);
+  writeClaudeMd(targetDir, adminPrefix);
   if (adminPrefix) writeNginxSample(targetDir, adminPrefix);
   writeProxyApp(targetDir, dirName, adminPrefix);
   writeCheckEnvScript(targetDir);
   writePm2Config(targetDir, dirName, adminPrefix);
   success(
-    `package.json, pnpm-workspace.yaml, .gitignore, .env.local, README.md${
+    `package.json, pnpm-workspace.yaml, .gitignore, .env.local, README.md, CLAUDE.md${
       adminPrefix ? ", nginx.conf.sample" : ""
     }, apps/proxy, ecosystem.config.cjs, scripts/check-env.mjs`,
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-apollo-monorepo",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Scaffold a monorepo with a frontend app and Apollo CMS as a git submodule backend (single-origin via Next.js rewrites + assetPrefix)",
   "bin": {
     "create-apollo-monorepo": "index.mjs"