create-enterprise-backend 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,89 @@
+# Create Enterprise Backend
+
+A CLI tool for scaffolding enterprise-ready backend applications with Express or Fastify, integrated with MongoDB or Supabase.
+
+## Features
+
+- **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
+
+## Installation
+
+Install globally using npm:
+
+```bash
+npm install -g create-enterprise-backend
+```
+
+Or use with npx without installing:
+
+```bash
+npx create-enterprise-backend
+```
+
+## Usage
+
+Run the CLI and follow the interactive prompts:
+
+```bash
+create-enterprise-backend [project-name]
+```
+
+### Options
+
+- **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
+
+### Example
+
+```bash
+npx create-enterprise-backend my-backend-app
+```
+
+This will create a new directory `my-backend-app` with the scaffolded backend.
+
+## Project Structure
+
+The generated project includes:
+
+- **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
+
+## Getting Started
+
+After generating the project:
+
+1. Navigate to the project directory:
+   ```bash
+   cd my-backend-app
+   ```
+
+2. Start the development server:
+   ```bash
+   npm run dev
+   ```
+
+3. The server will run on the configured port (check `src/config/env.js`).
+
+## Requirements
+
+- Node.js >= 18
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on [GitHub](https://github.com/ImaadDev/create-enterprise-backend).
+
+## License
+
+MIT# create-enterprise-backend

package/core/run.js

@@ -1,5 +1,4 @@
 import path from "path";
-import fs from "fs";
 import prompts from "prompts";
 import chalk from "chalk";
 import { generateProject } from "./scaffold.js";
@@ -34,7 +33,7 @@ export async function run() {
         message: "Select database",
         choices: [
           { title: "MongoDB", value: "mongo" },
-          { title: "Supabase", value: "supabase" },
+          { title: "Supabase", value: "supabase" }
         ]
       },
       {
@@ -57,25 +56,13 @@ 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,
@@ -89,7 +76,10 @@ export async function run() {
   }
 
   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,47 @@ function getPackageRoot() {
   return path.resolve(path.dirname(__filename), "..");
 }
 
-export async function generateProject({ framework, database, targetDir, projectName }) {
+const DB_MAP = {
+  mongo: "mongo",
+  supabase: "supabase"
+};
+
+export async function generateProject({
+  framework,
+  database,
+  targetDir,
+  projectName
+}) {
   const root = getPackageRoot();
 
-  const templateDir = path.join(root, "templates", framework, database);
+  const dbFolder = DB_MAP[database];
+  if (!dbFolder) {
+    throw new Error(`Unsupported database: ${database}`);
+  }
+
+  const templateDir = path.join(root, "templates", framework, dbFolder);
 
-  const exists = await fs.pathExists(templateDir);
-  if (!exists) {
-    throw new Error(`Template not found: ${framework}/${database}`);
+  if (!(await fs.pathExists(templateDir))) {
+    throw new Error(`Template not found: ${framework}/${dbFolder}`);
   }
 
-  if (await fs.pathExists(targetDir)) {
+  const isCurrentDir =
+    projectName === "." || projectName === "./";
+
+  if (!isCurrentDir && (await fs.pathExists(targetDir))) {
     throw new Error(`Target folder already exists: ${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)
+  // 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.1",
   "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"
 }