create-enterprise-backend 0.1.1 → 0.1.2

package/README.md

@@ -1,89 +1,165 @@
-# Create Enterprise Backend
+# 🚀 Create Enterprise Backend
 
-A CLI tool for scaffolding enterprise-ready backend applications with Express or Fastify, integrated with MongoDB or Supabase.
+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.
 
-## Features
+⚡ Zero setup. Secure defaults. Scalable structure.
 
-- **Frameworks**: Choose between Express.js or Fastify
-- **Databases**: Support for MongoDB or Supabase
-- **Authentication**: Pre-configured JWT authentication modules
-- **Middleware**: Built-in error handling, database guards, and JWT guards
-- **Project Structure**: Organized modular architecture for scalability
+## ✨ Features
 
-## Installation
+### 🏗 Frameworks
+- Express
+- Fastify
 
-Install globally using npm:
+### 🗄 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
-npm install -g create-enterprise-backend
+npx create-enterprise-backend my-backend
 ```
 
-Or use with npx without installing:
-
+**or inside the current folder:**
 ```bash
-npx create-enterprise-backend
+npx create-enterprise-backend .
 ```
 
-## Usage
+## 🧭 Interactive Setup
 
-Run the CLI and follow the interactive prompts:
+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
-create-enterprise-backend [project-name]
+npm run dev
 ```
 
-### Options
+**Output example:**
+```
+⚠️ Supabase public client disabled (missing env vars)
+⚠️ Supabase admin client disabled (missing env vars)
+🚀 Server running at http://localhost:5000
+```
 
-- **Project Name**: Optional. If not provided, you'll be prompted to enter it.
-- **Framework**: Select Express or Fastify
-- **Database**: Choose MongoDB or Supabase
-- **Install Dependencies**: Option to install npm packages immediately
+This is intentional and safe — the app won't crash if env vars are missing.
 
-### Example
+## 🔑 Environment Variables
 
-```bash
-npx create-enterprise-backend my-backend-app
+### MongoDB
+```
+PORT=5000
+MONGO_URI=mongodb://localhost:27017/myapp
+JWT_SECRET=supersecret
 ```
 
-This will create a new directory `my-backend-app` with the scaffolded backend.
+### Supabase
+```
+PORT=5000
+SUPABASE_URL=https://xxxx.supabase.co
+SUPABASE_ANON_KEY=public-key
+SUPABASE_SERVICE_ROLE_KEY=service-role-key
+JWT_SECRET=supersecret
+```
 
-## Project Structure
+## 🛡 Database Safety (Enterprise Behavior)
 
-The generated project includes:
+- 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
 
-- **src/app.js**: Main application setup
-- **src/server.js**: Server initialization
-- **src/routes.js**: Route definitions
-- **src/config/**: Configuration files (database, environment)
-- **src/middlewares/**: Custom middleware (guards, error handling)
-- **src/modules/**: Modular components (e.g., auth module)
-- **src/services/**: Business logic services
-- **src/utils/**: Utility functions
+## 🧪 Health Check
+```
+GET /health
+```
+
+**Response:**
+```json
+{
+  "status": "ok"
+}
+```
 
-## Getting Started
+## 📌 Node Version
+- Node.js ≥ 18
 
-After generating the project:
+## 🧠 Philosophy
 
-1. Navigate to the project directory:
-   ```bash
-   cd my-backend-app
-   ```
+This tool is built for:
+- SaaS backends
+- Admin dashboards
+- APIs at scale
+- Teams that care about structure & safety
 
-2. Start the development server:
-   ```bash
-   npm run dev
-   ```
+It's meant to be extended, not locked.
 
-3. The server will run on the configured port (check `src/config/env.js`).
+## 🛣 Roadmap
+- PostgreSQL & MySQL templates
+- Docker & CI templates
+- CLI flags (--yes, --framework, --db)
+- Prisma / Drizzle support
+- RBAC & multi-tenant auth
 
-## Requirements
+## 🤝 Contributing
 
-- Node.js >= 18
+Contributions are welcome!
+- Fork the repo
+- Create a feature branch
+- Submit a PR
 
-## Contributing
+## 📄 License
 
-Contributions are welcome! Please open an issue or submit a pull request on [GitHub](https://github.com/ImaadDev/create-enterprise-backend).
+MIT © Imad Hussain Khan
 
-## License
+## ⭐ Support
 
-MIT# create-enterprise-backend
+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,4 +1,5 @@
 import path from "path";
+import fs from "fs-extra";
 import prompts from "prompts";
 import chalk from "chalk";
 import { generateProject } from "./scaffold.js";
@@ -15,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",
@@ -54,7 +54,6 @@ export async function run() {
   );
 
   const projectName = (projectNameArg || answers.projectName).trim();
-  const { framework, database } = answers;
 
   const targetDir =
     projectName === "." || projectName === "./"
@@ -64,12 +63,18 @@ export async function run() {
   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 });

package/core/scaffold.js

@@ -19,8 +19,8 @@ export async function generateProject({
   projectName
 }) {
   const root = getPackageRoot();
-
   const dbFolder = DB_MAP[database];
+
   if (!dbFolder) {
     throw new Error(`Unsupported database: ${database}`);
   }
@@ -31,19 +31,29 @@ export async function generateProject({
     throw new Error(`Template not found: ${framework}/${dbFolder}`);
   }
 
-  const isCurrentDir =
-    projectName === "." || projectName === "./";
-
-  if (!isCurrentDir && (await fs.pathExists(targetDir))) {
-    throw new Error(`Target folder already exists: ${projectName}`);
-  }
+  const isCurrentDir = projectName === "." || projectName === "./";
 
   await fs.ensureDir(targetDir);
 
-  await fs.copy(templateDir, targetDir, {
-    overwrite: false,
-    errorOnExist: true
-  });
+  // 🔒 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");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-enterprise-backend",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Enterprise backend scaffolder (Express/Fastify + Mongo/Supabase)",
   "type": "module",
   "bin": {

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=