create-enterprise-backend 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,165 @@
+# 🚀 Create Enterprise Backend
+
+Create Enterprise Backend is a modern CLI tool to scaffold production-ready backend applications using Express or Fastify with MongoDB or Supabase, following enterprise best practices.
+
+⚡ Zero setup. Secure defaults. Scalable structure.
+
+## ✨ Features
+
+### 🏗 Frameworks
+- Express
+- Fastify
+
+### 🗄 Databases
+- MongoDB (Mongoose)
+- Supabase (Postgres + Auth)
+
+### 🔐 Authentication Ready
+- JWT-based auth
+- Auth guards & middleware
+- Safe handling when DB/env is missing
+
+### 🧱 Enterprise Architecture
+- Modular structure
+- Controllers / Services / Routes
+- Centralized error handling
+- Environment-based config
+
+### 🛠 Developer Experience
+- Nodemon preconfigured
+- Clean logging
+- Safe defaults (no crash if DB not configured)
+
+## 📦 Installation & Usage
+
+You don't need to install anything globally.
+
+**Create a new backend project**
+```bash
+npx create-enterprise-backend my-backend
+```
+
+**or inside the current folder:**
+```bash
+npx create-enterprise-backend .
+```
+
+## 🧭 Interactive Setup
+
+The CLI will guide you through:
+- Framework selection (Express / Fastify)
+- Database selection (MongoDB / Supabase)
+- Dependency installation (Install now or later)
+
+## 📁 Project Structure (Example)
+```
+src/
+├── app.js
+├── server.js
+├── routes.js
+├── config/
+│   ├── env.js
+│   ├── db.js          # Mongo
+│   └── supabase.js    # Supabase
+├── modules/
+│   └── auth/
+│       ├── auth.controller.js
+│       ├── auth.routes.js
+│       ├── auth.service.js
+│       ├── auth.schema.js
+│       └── user.model.js
+├── middlewares/
+├── services/
+└── utils/
+    ├── error-handler.js
+    ├── jwt-guard.js
+    └── db-guard.js
+```
+
+## ▶️ Running the Server
+```bash
+npm run dev
+```
+
+**Output example:**
+```
+⚠️ Supabase public client disabled (missing env vars)
+⚠️ Supabase admin client disabled (missing env vars)
+🚀 Server running at http://localhost:5000
+```
+
+This is intentional and safe — the app won't crash if env vars are missing.
+
+## 🔑 Environment Variables
+
+### MongoDB
+```
+PORT=5000
+MONGO_URI=mongodb://localhost:27017/myapp
+JWT_SECRET=supersecret
+```
+
+### Supabase
+```
+PORT=5000
+SUPABASE_URL=https://xxxx.supabase.co
+SUPABASE_ANON_KEY=public-key
+SUPABASE_SERVICE_ROLE_KEY=service-role-key
+JWT_SECRET=supersecret
+```
+
+## 🛡 Database Safety (Enterprise Behavior)
+
+- If DB is not connected, DB-dependent routes are automatically blocked
+- The server never crashes due to missing DB or env variables
+- Clear warnings are logged instead
+
+## 🧪 Health Check
+```
+GET /health
+```
+
+**Response:**
+```json
+{
+  "status": "ok"
+}
+```
+
+## 📌 Node Version
+- Node.js ≥ 18
+
+## 🧠 Philosophy
+
+This tool is built for:
+- SaaS backends
+- Admin dashboards
+- APIs at scale
+- Teams that care about structure & safety
+
+It's meant to be extended, not locked.
+
+## 🛣 Roadmap
+- PostgreSQL & MySQL templates
+- Docker & CI templates
+- CLI flags (--yes, --framework, --db)
+- Prisma / Drizzle support
+- RBAC & multi-tenant auth
+
+## 🤝 Contributing
+
+Contributions are welcome!
+- Fork the repo
+- Create a feature branch
+- Submit a PR
+
+## 📄 License
+
+MIT © Imad Hussain Khan
+
+## ⭐ Support
+
+If this tool helped you:
+- ⭐ Star the repo
+- 🐛 Report issues
+- 💡 Suggest features

package/core/install.js

@@ -1,5 +1,8 @@
 import { execSync } from "child_process";
 
 export async function installDeps({ targetDir }) {
-  execSync("npm install", { cwd: targetDir, stdio: "inherit" });
+  execSync("npm install", {
+    cwd: targetDir,
+    stdio: "inherit"
+  });
 }

package/core/run.js

@@ -1,5 +1,5 @@
 import path from "path";
-import fs from "fs";
+import fs from "fs-extra";
 import prompts from "prompts";
 import chalk from "chalk";
 import { generateProject } from "./scaffold.js";
@@ -16,8 +16,7 @@ export async function run() {
         type: projectNameArg ? null : "text",
         name: "projectName",
         message: "Project name?",
-        validate: (v) =>
-          v?.trim()?.length ? true : "Project name is required"
+        validate: v => v?.trim()?.length ? true : "Project name is required"
       },
       {
         type: "select",
@@ -34,7 +33,7 @@ export async function run() {
         message: "Select database",
         choices: [
           { title: "MongoDB", value: "mongo" },
-          { title: "Supabase", value: "supabase" },
+          { title: "Supabase", value: "supabase" }
         ]
       },
       {
@@ -55,41 +54,37 @@ export async function run() {
   );
 
   const projectName = (projectNameArg || answers.projectName).trim();
-  const { framework, database } = answers;
 
-  const templatePath = path.resolve(
-    "templates",
-    framework,
-    database
-  );
-
-  // ✅ Validate template exists
-  if (!fs.existsSync(templatePath)) {
-    console.log(
-      chalk.red(
-        `\n❌ Template not found for: ${framework} + ${database}\n`
-      )
-    );
-    process.exit(1);
-  }
-
-  const targetDir = path.join(process.cwd(), projectName);
+  const targetDir =
+    projectName === "." || projectName === "./"
+      ? process.cwd()
+      : path.join(process.cwd(), projectName);
 
   console.log(chalk.gray("\n📦 Generating project..."));
+
   await generateProject({
-    framework,
-    database,
+    framework: answers.framework,
+    database: answers.database,
     targetDir,
     projectName
   });
 
+  // 🔒 SAFETY CHECK
+  const pkgPath = path.join(targetDir, "package.json");
+  if (!(await fs.pathExists(pkgPath))) {
+    throw new Error("package.json not found. Scaffolding failed.");
+  }
+
   if (answers.install) {
     console.log(chalk.gray("\n📥 Installing dependencies..."));
     await installDeps({ targetDir });
   }
 
   console.log(chalk.green.bold("\n✅ Done!\n"));
-  console.log(
-    `Next steps:\n  cd ${projectName}\n  npm run dev\n`
-  );
+
+  if (projectName !== "." && projectName !== "./") {
+    console.log(`Next steps:\n  cd ${projectName}\n  npm run dev\n`);
+  } else {
+    console.log(`Next steps:\n  npm run dev\n`);
+  }
 }

package/core/scaffold.js

@@ -7,29 +7,57 @@ function getPackageRoot() {
   return path.resolve(path.dirname(__filename), "..");
 }
 
-export async function generateProject({ framework, database, targetDir, projectName }) {
-  const root = getPackageRoot();
+const DB_MAP = {
+  mongo: "mongo",
+  supabase: "supabase"
+};
 
-  const templateDir = path.join(root, "templates", framework, database);
+export async function generateProject({
+  framework,
+  database,
+  targetDir,
+  projectName
+}) {
+  const root = getPackageRoot();
+  const dbFolder = DB_MAP[database];
 
-  const exists = await fs.pathExists(templateDir);
-  if (!exists) {
-    throw new Error(`Template not found: ${framework}/${database}`);
+  if (!dbFolder) {
+    throw new Error(`Unsupported database: ${database}`);
   }
 
-  if (await fs.pathExists(targetDir)) {
-    throw new Error(`Target folder already exists: ${projectName}`);
+  const templateDir = path.join(root, "templates", framework, dbFolder);
+
+  if (!(await fs.pathExists(templateDir))) {
+    throw new Error(`Template not found: ${framework}/${dbFolder}`);
   }
 
+  const isCurrentDir = projectName === "." || projectName === "./";
+
   await fs.ensureDir(targetDir);
-  await fs.copy(templateDir, targetDir, {
-    overwrite: false,
-    errorOnExist: true
-  });
 
-  // Rename package name inside generated package.json (if template has one)
+  // 🔒 EMPTY DIRECTORY CHECK (CRITICAL)
+  if (isCurrentDir) {
+    const entries = await fs.readdir(targetDir);
+    const allowed = [".git", ".gitignore", ".DS_Store"];
+
+    const unsafe = entries.filter(e => !allowed.includes(e));
+    if (unsafe.length > 0) {
+      throw new Error(
+        "Current directory is not empty. Please use an empty folder."
+      );
+    }
+  } else {
+    if ((await fs.pathExists(targetDir)) && (await fs.readdir(targetDir)).length) {
+      throw new Error(`Target folder already exists: ${projectName}`);
+    }
+  }
+
+  // ✅ SAFE COPY
+  await fs.copy(templateDir, targetDir);
+
+  // Rename package.json only when not using "."
   const pkgPath = path.join(targetDir, "package.json");
-  if (await fs.pathExists(pkgPath)) {
+  if (!isCurrentDir && (await fs.pathExists(pkgPath))) {
     const pkg = await fs.readJson(pkgPath);
     pkg.name = projectName;
     await fs.writeJson(pkgPath, pkg, { spaces: 2 });

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "create-enterprise-backend",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Enterprise backend scaffolder (Express/Fastify + Mongo/Supabase)",
   "type": "module",
   "bin": {
     "create-enterprise-backend": "./bin/cli.js"
   },
-  "files": ["bin", "core", "templates", "README.md"],
+  "files": [
+    "bin",
+    "core",
+    "templates",
+    "README.md"
+  ],
   "keywords": [
     "cli",
     "scaffold",
@@ -24,5 +29,13 @@
     "chalk": "^5.3.0",
     "fs-extra": "^11.2.0",
     "prompts": "^2.4.2"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ImaadDev/create-enterprise-backend"
+  },
+  "bugs": {
+    "url": "https://github.com/ImaadDev/create-enterprise-backend/issues"
+  },
+  "homepage": "https://github.com/ImaadDev/create-enterprise-backend#README"
 }

package/templates/express/mongo/.env.example

@@ -0,0 +1,3 @@
+PORT=5000
+MONGO_URI=
+JWT_SECRET=change_me

package/templates/fastify/mongo/.env.example

@@ -0,0 +1,3 @@
+PORT=5000
+MONGO_URI=
+JWT_SECRET=change_me

package/templates/fastify/supabase/.env.example

@@ -0,0 +1,4 @@
+PORT=5000
+SUPABASE_URL=
+SUPABASE_ANON_KEY=
+SUPABASE_SERVICE_ROLE_KEY=