create-zhx-monorepo 2.1.1 → 2.2.0

package/bin/index.js

@@ -1,118 +1,127 @@
-#!/usr/bin/env node
-import fs from "fs-extra";
-import path from "path";
-import prompts from "prompts";
-import { fileURLToPath } from "url";
-import { green, cyan, red } from "kolorist";
-import { execSync } from "child_process";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const replaceDbName = async (filePath, projectName) => {
-  if (!(await fs.pathExists(filePath))) return;
-
-  let content = await fs.readFile(filePath, "utf-8");
-  content = content.replace(
-    /postgresql:\/\/([^/]+)\/your-proj/g,
-    `postgresql://$1/${projectName}`
-  );
-  await fs.writeFile(filePath, content);
-};
-
-const normalizeProjectName = (name) => {
-  return name.trim().toLowerCase().replace(/\s+/g, "-");
-};
-
-const main = async () => {
-  let targetDir = process.argv[2];
-
-  if (!targetDir) {
-    const response = await prompts({
-      type: "text",
-      name: "targetDir",
-      message: "Project name:",
-      validate: (value) => (value ? true : "Project name cannot be empty"),
-    });
-
-    targetDir = response.targetDir;
-
-    if (!targetDir) {
-      console.log(red("❌ No project name provided."));
-      process.exit(1);
-    }
-  }
-
-  targetDir = normalizeProjectName(targetDir);
-
-  const projectPath = path.resolve(process.cwd(), targetDir);
-
-  if (fs.existsSync(projectPath)) {
-    console.log(red("❌ Directory already exists"));
-    process.exit(1);
-  }
-
-  const { gitRemote } = await prompts({
-    type: "text",
-    name: "gitRemote",
-    message: "Git remote URL (optional):",
-  });
-
-  console.log(cyan("📦 Creating project..."));
-
-  // Copy template
-  const templateDir = path.join(__dirname, "../templates/monorepo-starter");
-  await fs.copy(templateDir, projectPath);
-
-  // Update package.json
-  const pkgPath = path.join(projectPath, "package.json");
-  const pkg = await fs.readJson(pkgPath);
-  pkg.name = targetDir;
-  await fs.writeJson(pkgPath, pkg, { spaces: 2 });
-
-  // Rename gitignore
-  const gitignoreSrc = path.join(projectPath, "gitignore");
-  const gitignoreDest = path.join(projectPath, ".gitignore");
-  if (fs.existsSync(gitignoreSrc)) {
-    fs.renameSync(gitignoreSrc, gitignoreDest);
-  }
-
-  // --- SERVER SETUP ---
-  const serverDir = path.join(projectPath, "server");
-  const prismaDir = path.join(serverDir, "prisma");
-
-  // Remove prisma folders
-  await fs.remove(path.join(prismaDir, "migrations"));
-  await fs.remove(path.join(prismaDir, "generated"));
-
-  // Create .env from example
-  const envExamplePath = path.join(serverDir, ".env.example");
-  const envPath = path.join(serverDir, ".env");
-
-  if (await fs.pathExists(envExamplePath)) {
-    await fs.copy(envExamplePath, envPath);
-  }
-
-  // Replace DB name
-  await replaceDbName(envExamplePath, targetDir);
-  await replaceDbName(envPath, targetDir);
-
-  // Init git
-  process.chdir(projectPath);
-  execSync("git init", { stdio: "ignore" });
-  execSync("git add .", { stdio: "ignore" });
-  execSync('git commit -m "Initial commit"', { stdio: "ignore" });
-
-  if (gitRemote) {
-    execSync(`git remote add origin ${gitRemote}`, { stdio: "ignore" });
-  }
-
-  console.log(green("✅ Project ready!"));
-  console.log();
-  console.log("Next steps:");
-  console.log(`  cd ${targetDir}`);
-  console.log("  pnpm install");
-  console.log("  pnpm dev");
-};
-
+#!/usr/bin/env node
+import fs from "fs-extra";
+import path from "path";
+import prompts from "prompts";
+import { fileURLToPath } from "url";
+import { green, cyan, red } from "kolorist";
+import { execSync } from "child_process";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const replaceDbName = async (filePath, projectName) => {
+  if (!(await fs.pathExists(filePath))) return;
+
+  let content = await fs.readFile(filePath, "utf-8");
+  content = content.replace(
+    /postgresql:\/\/([^/]+)\/[^"\s]+/g,
+    `postgresql://$1/${projectName}`,
+  );
+  await fs.writeFile(filePath, content);
+};
+
+const replaceInFile = async (filePath, replacements) => {
+  if (!(await fs.pathExists(filePath))) return;
+
+  let content = await fs.readFile(filePath, "utf-8");
+  for (const [pattern, value] of replacements) {
+    content = content.replace(pattern, value);
+  }
+  await fs.writeFile(filePath, content);
+};
+
+const normalizeProjectName = (name) => {
+  return name.trim().toLowerCase().replace(/\s+/g, "-");
+};
+
+const main = async () => {
+  let targetDir = process.argv[2];
+
+  if (!targetDir) {
+    const response = await prompts({
+      type: "text",
+      name: "targetDir",
+      message: "Project name:",
+      validate: (value) => (value ? true : "Project name cannot be empty"),
+    });
+
+    targetDir = response.targetDir;
+
+    if (!targetDir) {
+      console.log(red("❌ No project name provided."));
+      process.exit(1);
+    }
+  }
+
+  targetDir = normalizeProjectName(targetDir);
+
+  const projectPath = path.resolve(process.cwd(), targetDir);
+
+  if (fs.existsSync(projectPath)) {
+    console.log(red("❌ Directory already exists"));
+    process.exit(1);
+  }
+
+  const { gitRemote } = await prompts({
+    type: "text",
+    name: "gitRemote",
+    message: "Git remote URL (optional):",
+  });
+
+  console.log(cyan("📦 Creating project..."));
+
+  const templateDir = path.join(__dirname, "../templates/monorepo-starter");
+  await fs.copy(templateDir, projectPath);
+
+  const pkgPath = path.join(projectPath, "package.json");
+  const pkg = await fs.readJson(pkgPath);
+  pkg.name = targetDir;
+  await fs.writeJson(pkgPath, pkg, { spaces: 2 });
+
+  const gitignoreSrc = path.join(projectPath, "gitignore");
+  const gitignoreDest = path.join(projectPath, ".gitignore");
+  if (fs.existsSync(gitignoreSrc)) {
+    fs.renameSync(gitignoreSrc, gitignoreDest);
+  }
+
+  const serverDir = path.join(projectPath, "server");
+  const dbDir = path.join(projectPath, "packages/db");
+  const prismaDir = path.join(dbDir, "prisma");
+
+  await fs.remove(path.join(prismaDir, "migrations"));
+  await fs.remove(path.join(prismaDir, "generated"));
+
+  const envExamplePath = path.join(serverDir, ".env.example");
+  const envPath = path.join(serverDir, ".env");
+
+  if (await fs.pathExists(envExamplePath)) {
+    await fs.copy(envExamplePath, envPath);
+  }
+
+  await replaceDbName(envExamplePath, targetDir);
+  await replaceDbName(envPath, targetDir);
+  await replaceInFile(envExamplePath, [[/Starter Admin/g, `${targetDir} Admin`]]);
+  await replaceInFile(envPath, [[/Starter Admin/g, `${targetDir} Admin`]]);
+  await replaceInFile(path.join(projectPath, "README.md"), [
+    [/Monorepo Starter/g, targetDir],
+  ]);
+
+  process.chdir(projectPath);
+  execSync("git init", { stdio: "ignore" });
+  execSync("git branch -M main", { stdio: "ignore" });
+  execSync("git add .", { stdio: "ignore" });
+  execSync('git commit -m "Initial commit"', { stdio: "ignore" });
+
+  if (gitRemote) {
+    execSync(`git remote add origin ${gitRemote}`, { stdio: "ignore" });
+  }
+
+  console.log(green("✅ Project ready!"));
+  console.log();
+  console.log("Next steps:");
+  console.log(`  cd ${targetDir}`);
+  console.log("  pnpm install");
+  console.log("  pnpm dev");
+};
+
 main();

package/package.json

@@ -1,12 +1,25 @@
 {
   "name": "create-zhx-monorepo",
-  "version": "2.1.1",
-  "description": "Create a ZHX monorepo with one command",
+  "version": "2.2.0",
+  "description": "Create a production-ready ZHX monorepo with one command",
   "bin": {
     "create-zhx-monorepo": "bin/index.js"
   },
   "type": "module",
   "license": "MIT",
+  "files": [
+    "bin",
+    "templates",
+    "README.md"
+  ],
+  "keywords": [
+    "monorepo",
+    "turbo",
+    "pnpm",
+    "nextjs",
+    "nestjs",
+    "starter"
+  ],
   "engines": {
     "node": ">=24"
   },

package/templates/monorepo-starter/.dockerignore

@@ -0,0 +1,14 @@
+node_modules
+.turbo
+.next
+.git
+.gitignore
+.env
+.env.*
+**/.env
+**/.env.*
+dist
+logs
+apps
+coverage
+

package/templates/monorepo-starter/Dockerfile

@@ -0,0 +1,76 @@
+# syntax=docker/dockerfile:1.7
+
+# ---------- BASE ----------
+FROM node:24-alpine AS base
+WORKDIR /app
+
+ENV TURBO_TELEMETRY_DISABLED=1
+
+# Enable pnpm via Corepack and pin version
+RUN corepack enable && corepack prepare pnpm@10.28.0 --activate
+
+# ---------- PRUNE ----------
+FROM base AS pruner
+WORKDIR /app
+
+COPY . .
+
+# Use local turbo version for consistent behavior
+RUN pnpm dlx turbo@2.8.13 prune server --docker
+
+# ---------- INSTALL ----------
+FROM base AS installer
+WORKDIR /app
+
+# Copy dependency graph and lockfile
+COPY --from=pruner /app/out/json/ .  
+COPY --from=pruner /app/out/pnpm-lock.yaml ./pnpm-lock.yaml
+
+# Use BuildKit cache for pnpm store
+RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store \
+    pnpm fetch
+
+RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store \
+    pnpm install --frozen-lockfile --offline
+
+# Copy pruned full source
+COPY --from=pruner /app/out/full/ .
+
+# ---------- BUILD ----------
+FROM installer AS builder
+WORKDIR /app
+
+# Build only the server
+RUN pnpm build:server
+
+# ---------- RUNNER ----------
+FROM node:24-alpine AS runner
+WORKDIR /app
+
+RUN apk add --no-cache ca-certificates
+
+ENV TURBO_TELEMETRY_DISABLED=1
+
+# The Cloud Run migration Job runs `pnpm ...`, so pnpm must exist in the runtime image.
+RUN corepack enable && corepack prepare pnpm@10.28.0 --activate
+
+ENV NODE_ENV=production
+ENV PORT=8080
+
+# Copy metadata and built server
+COPY --from=builder /app/package.json ./package.json    
+COPY --from=builder /app/pnpm-workspace.yaml ./pnpm-workspace.yaml
+COPY --from=builder /app/pnpm-lock.yaml ./pnpm-lock.yaml
+COPY --from=builder /app/turbo.json ./turbo.json
+
+COPY --from=builder /app/server/dist ./server/dist
+COPY --from=builder /app/server/package.json ./server/package.json
+
+# Copy dependencies and workspace packages
+COPY --from=builder /app/node_modules ./node_modules
+COPY --from=builder /app/server/node_modules ./server/node_modules
+COPY --from=builder /app/packages ./packages
+
+EXPOSE 8080
+
+CMD ["node", "server/dist/main.js"]

package/templates/monorepo-starter/README.md

@@ -1,67 +1,87 @@
-# Monorepo Starter Template
-
-This is a minimal, modern monorepo template based on shadcn/ui, customized for fast development and scalability.
-
-## Features
-
-- Modular structure for web, server, and shared packages
-- Customizable UI components (`packages/ui`)
-- Tailwind CSS and PostCSS preconfigured
-- TypeScript everywhere
-- Ready for Next.js and NestJS
-- ESLint, TurboRepo, and PNPM workspace setup
-
-## Structure
-
-- `apps/web` – Next.js frontend
-- `server` – NestJS backend
-- `packages/ui` – Shared UI components
-- `packages/config` – Shared configs (ESLint, TypeScript)
-
-## Getting Started
-
-```bash
-pnpm install
-pnpm dev # Start all apps
-```
-
-## Database Setup
-
-1. Edit the `.env` file in the `server` directory:
-
-```env
-DB_URI="postgresql://username:password@localhost:5432/your-db-name"
-```
-
-Replace `username`, `password`, and `your-db-name` with your PostgreSQL credentials and the desired database name.
-
-2. Navigate to the server folder:
-
-```bash
-cd server
-```
-
-3. Run Prisma commands to set up the database and generate the client:
-
-```bash
-pnpm prisma:migrate:dev
-pnpm prisma:generate
-```
-
-> Note: Make sure your PostgreSQL server is running and accessible with the credentials you set.
-
-## Usage
-
-Import UI components in your app:
-
-```tsx
-import { Button } from "@workspace/ui/components/button";
-```
-
-## Customization
-
-Feel free to modify, extend, and organize the template to fit your workflow.
-
----
-
-Made with ❤️ using shadcn/ui & Monorepo
+# Monorepo Starter
+
+A production-oriented monorepo starter with:
+
+- `apps/web` for the public Next.js app
+- `apps/dashboard` for the internal/admin Next.js app
+- `server` for the NestJS API
+- `packages/contracts`, `packages/sdk`, `packages/ui`, `packages/templates`, and `packages/shared`
+- `packages/db` for Prisma schema, migrations, seed data, and generated client exports
+
+## Prerequisites
+
+- Node.js `24+`
+- `pnpm` `10+`
+- PostgreSQL
+
+Optional integrations:
+
+- Cloudinary
+- SMTP
+- Google OAuth
+- Facebook OAuth
+- Firebase push notifications
+
+## Local Setup
+
+1. Install dependencies.
+
+```bash
+pnpm install
+```
+
+2. Copy `server/.env.example` to `server/.env` and fill in the values you need.
+
+3. Create `apps/web/.env.local` and `apps/dashboard/.env.local`.
+
+```env
+NEXT_PUBLIC_API_URL="http://localhost:4000"
+```
+
+4. Generate Prisma client and apply local migrations.
+
+```bash
+pnpm --filter @workspace/db prisma:generate
+pnpm --filter @workspace/db prisma:migrate
+pnpm --filter @workspace/db prisma:seed
+```
+
+5. Start the apps you need.
+
+```bash
+pnpm --filter server dev
+pnpm --filter web dev
+pnpm --filter dashboard dev
+```
+
+Default local endpoints:
+
+- API: `http://localhost:4000`
+- Website: `http://localhost:3000`
+- Dashboard: `http://localhost:3001`
+
+## Useful Commands
+
+```bash
+pnpm check-types
+pnpm lint
+pnpm build
+pnpm build:server
+pnpm build:web
+pnpm build:dashboard
+pnpm prune:server
+```
+
+## Deployment Notes
+
+- The template includes a root `Dockerfile` for packaging the NestJS server with `turbo prune`.
+- `packages/db` owns Prisma schema, migrations, seed scripts, and typed exports.
+- `apps/web` and `apps/dashboard` are ready to point at the API through `NEXT_PUBLIC_API_URL`.
+
+## Package Highlights
+
+- `@workspace/contracts` keeps DTOs and schemas aligned across server and frontend
+- `@workspace/sdk` centralizes API client calls
+- `@workspace/ui` holds shared design system primitives
+- `@workspace/templates` contains email templates
+- `@workspace/shared` keeps framework-agnostic utilities/constants

package/templates/monorepo-starter/apps/dashboard/.env.local

@@ -0,0 +1,4 @@
+# App
+
+# Server
+NEXT_PUBLIC_API_URL="http://192.168.100.9:4000"

package/templates/monorepo-starter/apps/dashboard/.turbo/turbo-build.log

@@ -0,0 +1,46 @@
+[?9001h[?1004h]0;C:\WINDOWS\system32\cmd.exe[?25h[?25l
+> dashboard@0.0.1 build D:\create-zhx-monorepo\templates\monorepo-starter\apps\dashboard
+> next build[?25h⚠ Warning: Next.js inferred your workspace root, but it may not be correct.
+ We detected multiple lockfiles and selected the directory of D:\create-zhx-monorepo\pnpm-lock.yaml as the root directory.
+ To silence this warning, set `turbopack.root` in your Next.js config, or consider removing one of the lockfiles if it's not needed.
+   See https://nextjs.org/docs/app/api-reference/config/next-confi
+ig-js/turbopack#root-directory for more information.
+ Detected additional lockfiles:
+   * D:\create-zhx-monorepo\templates\monorepo-starter\pnpm-lock.y
+yaml
+
+▲ Next.js 16.1.6 (Turbopack)
+- Environments: .env.local
+
+  Creating an optimized production build ...
+✓ Compiled successfully in 12.6s
+[?25l  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
  Running TypeScript  ...
  Running TypeScript  .
  Running TypeScript  ..
+  Collecting page data using 11 workers  .[?25l
  Collecting page data using 11 workers  ..
  Collecting page data using 11 workers  ...
  Collecting page data using 11 workers  .
  Collecting page data using 11 workers  ..
  Collecting page data using 11 workers  ...
+[?25l  Generating static pages using 11 workers (0/14)  [    ]
  Generating static pages using 11 workers (0/14)  [=   ]
  Generating static pages using 11 workers (0/14)  [==  ]
  Generating static pages using 11 workers (8/14)  [=== ]
+  Finalizing page optimization  .[?25l
+
+Route (app)
+┌ ○ /_not-found
+├ ○ /admin/audit-logs
+├ ƒ /admin/audit-logs/[id]
+├ ○ /admin/leads/subscribers
+├ ƒ /admin/leads/subscribers/[id]
+├ ○ /admin/traffic-sources
+├ ƒ /admin/traffic-sources/[id]
+├ ○ /admin/users
+├ ƒ /admin/users/[id]
+├ ƒ /admin/users/[id]/edit
+├ ○ /admin/users/new
+├ ƒ /auth/[type]
+├ ƒ /auth/verify
+├ ○ /dashboard
+├ ○ /media
+├ ○ /notifications
+├ ○ /settings
+└ ○ /users/account
+
+
+○  (Static)   prerendered as static content
+ƒ  (Dynamic)  server-rendered on demand
+
+[?9001l[?1004l

package/templates/monorepo-starter/apps/dashboard/.turbo/turbo-check-types.log

@@ -0,0 +1,3 @@
+[?9001h[?1004h]0;C:\WINDOWS\system32\cmd.exe[?25h[?25l
+> dashboard@0.0.1 check-types D:\create-zhx-monorepo\templates\monorepo-starter\apps\dashboard
+> tsc --noEmit[?25h[?9001l[?1004l

package/templates/monorepo-starter/apps/dashboard/next-env.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
-import "./.next/dev/types/routes.d.ts";
+import "./.next/types/routes.d.ts";
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

package/templates/monorepo-starter/apps/dashboard/next.config.mjs

@@ -1,6 +1,6 @@
 /** @type {import('next').NextConfig} */
 const nextConfig = {
-  transpilePackages: ["@workspace/ui"],
+  transpilePackages: ["@workspace/ui", "@workspace/sdk"],
   allowedDevOrigins: ["192.168.100.9"],
 
   images: {
@@ -13,6 +13,10 @@ const nextConfig = {
         protocol: "https",
         hostname: "lh3.googleusercontent.com",
       },
+      {
+        protocol: "https",
+        hostname: "picsum.photos",
+      },
     ],
   },