create-express-dex 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Viraj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,221 @@
+# Dex - Fast Express Backend Scaffolding CLI
+
+<p align="center">
+  <img src="https://res.cloudinary.com/dzeuvnjmh/image/upload/v1765869170/dex_xcmsl0.png" alt="Dex Logo" width="200">
+</p>
+
+<p align="center">
+  <strong>A fast CLI tool to scaffold Express.js backend projects with TypeScript or JavaScript</strong>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/Node.js-18+-339933?logo=node.js&logoColor=white" alt="Node.js">
+  <img src="https://img.shields.io/badge/Express-5-000000?logo=express&logoColor=white" alt="Express">
+  <img src="https://img.shields.io/badge/TypeScript-5.7-3178C6?logo=typescript&logoColor=white" alt="TypeScript">
+  <img src="https://img.shields.io/badge/Package_Managers-npm%20%7C%20pnpm%20%7C%20yarn%20%7C%20bun-CB3837?logo=npm&logoColor=white" alt="Package Managers">
+</p>
+
+---
+
+## Features
+
+### **Instant Project Setup**
+
+- Interactive CLI prompts for project configuration
+- Choose between **JavaScript** or **TypeScript**
+- Optional **MongoDB with Mongoose** integration
+- Support for **npm, pnpm, yarn, and bun** package managers
+
+### **Smart Configuration**
+
+- Pre-configured Express server with best practices
+- CORS and body parsing middleware included
+- Environment variable management with `.env` files
+- Dynamic MongoDB connection strings based on project name
+
+### **Production-Ready Structure**
+
+- Clean, organized project structure
+- Separate database configuration files
+- Ready-to-use server entry point
+- Proper `.gitignore` configuration
+
+### **Developer Experience**
+
+- Fast development server with `nodemon` (like Vite for backend!)
+- TypeScript support with proper configuration
+- Automatic dependency installation
+- Clear next-steps instructions after setup
+
+### **Not a Framework**
+
+Dex is a **scaffolding tool**, not a framework. It generates a clean Express.js project with sensible defaults, giving you full control over your code without any lock-in or abstraction layers.
+
+---
+
+## Prerequisites
+
+- **Node.js** 18 or higher
+- **npm**, **pnpm**, **yarn**, or **bun** (your choice!)
+
+---
+
+## Quick Start
+
+```bash
+npm create express-dex
+
+or
+
+npx create-express-dex
+```
+
+That's it! The CLI will guide you through the setup process.
+
+## Usage
+
+When you run `npm create express-dex`, you'll be prompted with the following questions:
+
+1. **Project Name**: Enter your project name (default: `my-dex-project`)
+2. **Language**: Choose between `JavaScript` or `TypeScript`
+3. **Package Manager**: Select `npm`, `pnpm`, `yarn`, or `bun`
+4. **MongoDB**: Choose whether to include MongoDB with Mongoose
+
+### Example Session
+
+```bash
+$ npm create express-dex
+
+Welcome to Dex!
+
+██████╗ ███████╗██╗  ██╗
+██╔══██╗██╔════╝╚██╗██╔╝
+██║  ██║█████╗   ╚███╔╝
+██║  ██║██╔══╝   ██╔██╗
+██████╔╝███████╗██╔╝ ██╗
+╚═════╝ ╚══════╝╚═╝  ╚═╝
+
+? What is the name of your project? : my-awesome-api
+? Which language do you want to use? TypeScript
+? Which package manager do you want to use? npm
+? Do you want to use MongoDB with Mongoose? Yes
+
+Scaffolding project in /path/to/my-awesome-api...
+Setting up MongoDB...
+Installing dependencies...
+
+Success! Created my-awesome-api at /path/to/my-awesome-api
+
+Inside that directory, you can run:
+
+  npm run dev
+    Starts the development server.
+
+We suggest that you begin by typing:
+
+  cd my-awesome-api
+  npm run dev
+```
+
+---
+
+## Generated Project Structure
+
+### JavaScript Project
+
+```
+my-project/
+├── src/
+│   ├── db/              # MongoDB connection (if selected)
+│   │   └── index.js
+│   └── server.js        # Express server entry point
+├── .env                 # Environment variables
+├── .gitignore
+├── package.json
+```
+
+### TypeScript Project
+
+```
+my-project/
+├── src/
+│   ├── db/              # MongoDB connection (if selected)
+│   │   └── index.ts
+│   └── server.ts        # Express server entry point
+├── .env                 # Environment variables
+├── .gitignore
+├── package.json
+└── tsconfig.json
+```
+
+---
+
+## Environment Variables
+
+Dex automatically generates a `.env` file with the following variables:
+
+### Without MongoDB
+
+```env
+PORT=5000
+CORS_ORIGIN=*
+```
+
+### With MongoDB
+
+```env
+PORT=5000
+CORS_ORIGIN=*
+MONGODB_URI=mongodb://localhost:27017/my-project
+```
+
+---
+
+## Package Manager Support
+
+Dex supports all major package managers:
+
+| Package Manager | Installation Command | Run Dev Server |
+| --------------- | -------------------- | -------------- |
+| **npm**         | `npm install`        | `npm run dev`  |
+| **pnpm**        | `pnpm install`       | `pnpm run dev` |
+| **yarn**        | `yarn`               | `yarn run dev` |
+| **bun**         | `bun install`        | `bun run dev`  |
+
+The CLI will automatically use your selected package manager for installation and display the correct commands in the success message.
+
+---
+
+### Project Structure (CLI Source)
+
+```
+dex/
+├── src/
+│   └── index.ts         # Main CLI logic
+├── templates/
+│   ├── js/              # JavaScript templates
+│   │   ├── src/
+│   │   ├── package.json
+│   │   └── _gitignore
+│   └── ts/              # TypeScript templates
+│       ├── src/
+│       ├── package.json
+│       ├── tsconfig.json
+│       └── _gitignore
+├── bin/
+│   └── index.js         # Compiled output
+├── package.json
+└── tsconfig.json
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+---
+
+<p align="center">
+  Made with ❤️ by the Viraj :)
+</p>

package/bin/index.js

@@ -0,0 +1,209 @@
+#!/usr/bin/env node
+import inquirer from "inquirer";
+import fs from "fs-extra";
+import path from "path";
+import { fileURLToPath } from "url";
+import chalk from "chalk";
+import { execSync } from "child_process";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+async function init() {
+    const logo = `
+██████╗ ███████╗██╗  ██╗
+██╔══██╗██╔════╝╚██╗██╔╝
+██║  ██║█████╗   ╚███╔╝ 
+██║  ██║██╔══╝   ██╔██╗ 
+██████╔╝███████╗██╔╝ ██╗
+╚═════╝ ╚══════╝╚═╝  ╚═╝
+`;
+    console.log(chalk.bold.cyan("Welcome to Dex!"));
+    console.log(chalk.bold.cyan(logo));
+    const answers = await inquirer.prompt([
+        {
+            type: "input",
+            name: "projectName",
+            message: "What is the name of your project? :",
+            default: "my-dex-project",
+            validate: (input) => {
+                if (/^([a-z0-9\-\_\.]+)$/.test(input))
+                    return true;
+                return "Project name may only include lower-case letters, numbers, hashes, dots and underscores.";
+            },
+        },
+        {
+            type: "list",
+            name: "language",
+            message: "Which language do you want to use?",
+            choices: ["JavaScript", "TypeScript"],
+            default: "JavaScript",
+        },
+        {
+            type: "list",
+            name: "packageManager",
+            message: "Which package manager do you want to use?",
+            choices: ["npm", "pnpm", "yarn", "bun"],
+            default: "npm",
+        },
+        {
+            type: "confirm",
+            name: "useMongo",
+            message: "Do you want to use MongoDB with Mongoose?",
+            default: false,
+        },
+    ]);
+    const { projectName, language, useMongo, packageManager } = answers;
+    const targetDir = path.join(process.cwd(), projectName);
+    const templateName = language === "TypeScript" ? "ts" : "js";
+    const templateDir = path.join(__dirname, "..", "templates", templateName);
+    if (fs.existsSync(targetDir)) {
+        console.error(chalk.red(`Directory ${projectName} already exists!`));
+        process.exit(1);
+    }
+    console.log(chalk.blue(`\nScaffolding project in ${targetDir}...`));
+    // Copy template
+    try {
+        await fs.copy(templateDir, targetDir);
+        if (await fs.pathExists(path.join(targetDir, "_gitignore"))) {
+            await fs.move(path.join(targetDir, "_gitignore"), path.join(targetDir, ".gitignore"));
+        }
+    }
+    catch (err) {
+        console.error(chalk.red("Error copying template files:"), err);
+        process.exit(1);
+    }
+    // Handle MongoDB logic
+    if (useMongo) {
+        console.log(chalk.blue("Setting up MongoDB..."));
+        const dbFileExt = language === "TypeScript" ? "ts" : "js";
+        const dbPath = path.join(targetDir, "src", "db", `index.${dbFileExt}`);
+        const dbCode = language === "TypeScript"
+            ? `import mongoose from 'mongoose';
+
+const connectDB = async () => {
+    try {
+        const connectionInstance = await mongoose.connect(\`\${process.env.MONGODB_URI}\`);
+        console.log(\`MongoDB connected successfully!\`);
+    } catch (error) {
+        console.log("MONGODB connection FAILED ", error);
+        process.exit(1);
+    }
+}
+
+export default connectDB;`
+            : `import mongoose from "mongoose";
+
+const connectDB = async () => {
+    try {
+        const connectionInstance = await mongoose.connect(\`\${process.env.MONGODB_URI}\`);
+        console.log(\`MongoDB connected successfully!\`);
+    } catch (error) {
+        console.log("MONGODB connection FAILED ", error);
+        process.exit(1);
+    }
+}
+
+export default connectDB;`;
+        await fs.outputFile(dbPath, dbCode);
+        const serverFile = path.join(targetDir, "src", `server.${dbFileExt}`);
+        const serverCode = language === "TypeScript"
+            ? `import express, { Express } from "express";
+import cors from "cors";
+import dotenv from "dotenv";
+import connectDB from "./db/index.js";
+
+dotenv.config({
+    path: './.env'
+});
+
+const app: Express = express();
+
+app.use(cors({
+    origin: process.env.CORS_ORIGIN,
+    credentials: true
+}));
+
+app.use(express.json({limit: "16kb"}));
+app.use(express.urlencoded({extended: true, limit: "16kb"}));
+
+// routes declaration
+
+connectDB()
+.then(() => {
+    app.listen(process.env.PORT || 5000, () => {
+        console.log(\`Server running on port \${process.env.PORT || 5000}\`);
+    })
+})
+.catch((err) => {
+    console.log("MONGO db connection failed! ", err);
+});`
+            : `import express from "express";
+import cors from "cors";
+import dotenv from "dotenv";
+import connectDB from "./db/index.js";
+
+dotenv.config({
+    path: './.env'
+});
+
+const app = express();
+
+app.use(cors({
+    origin: process.env.CORS_ORIGIN,
+    credentials: true
+}));
+
+app.use(express.json({limit: "16kb"}));
+app.use(express.urlencoded({extended: true, limit: "16kb"}));
+
+// routes declaration
+
+
+connectDB()
+.then(() => {
+    app.listen(process.env.PORT || 5000, () => {
+        console.log(\`Server running on port \${process.env.PORT || 5000}\`);
+    })
+})
+.catch((err) => {
+    console.log("MONGO db connection failed !!! ", err);
+});`;
+        await fs.outputFile(serverFile, serverCode);
+    }
+    const pkgJsonPath = path.join(targetDir, "package.json");
+    const pkgJson = await fs.readJson(pkgJsonPath);
+    pkgJson.name = projectName;
+    if (useMongo) {
+        console.log(chalk.blue("Adding mongoose..."));
+        pkgJson.dependencies = pkgJson.dependencies || {};
+        pkgJson.dependencies.mongoose = "^8.0.0";
+    }
+    await fs.writeJson(pkgJsonPath, pkgJson, { spaces: 2 });
+    // Generate .env file dynamically
+    const envContent = [
+        "PORT=5000",
+        "CORS_ORIGIN=*",
+        useMongo ? `MONGODB_URI=mongodb://localhost:27017/${projectName}` : "",
+    ]
+        .filter(Boolean)
+        .join("\n");
+    await fs.outputFile(path.join(targetDir, ".env"), envContent);
+    console.log(chalk.blue("Installing dependencies..."));
+    try {
+        const installCommand = packageManager === "yarn" ? "yarn" : `${packageManager} install`;
+        execSync(installCommand, { stdio: "inherit", cwd: targetDir });
+    }
+    catch (err) {
+        console.error(chalk.red("Error installing dependencies."), err);
+    }
+    console.log(chalk.green(`\nSuccess! Created ${projectName} at ${targetDir}`));
+    console.log("\nInside that directory, you can run:");
+    console.log(`\n  ${chalk.cyan(`${packageManager} run dev`)}`);
+    console.log("    Starts the development server.");
+    console.log("\nWe suggest that you begin by typing:");
+    console.log(`\n  ${chalk.cyan("cd")} ${projectName}`);
+    console.log(`  ${chalk.cyan(`${packageManager} run dev`)}`);
+}
+init().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "create-express-dex",
+  "version": "0.1.1",
+  "description": "A fast CLI to scaffold Express.js backend projects with TypeScript or JavaScript",
+  "main": "bin/index.js",
+  "type": "module",
+  "bin": {
+    "create-express-dex": "./bin/index.js"
+  },
+  "files": [
+    "bin",
+    "templates"
+  ],
+  "scripts": {
+    "dev": "tsx src/index.ts",
+    "build": "tsc",
+    "watch": "tsc -w",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "express",
+    "generator",
+    "starter",
+    "scaffold",
+    "backend",
+    "nodejs",
+    "typescript",
+    "javascript",
+    "mongodb",
+    "mongoose",
+    "create",
+    "boilerplate",
+    "template"
+  ],
+  "author": "Viraj",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/viraj-ap/dex.git"
+  },
+  "bugs": {
+    "url": "https://github.com/viraj-ap/dex/issues"
+  },
+  "homepage": "https://dex-omega-fawn.vercel.app/",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^9.2.12"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^22.10.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/templates/js/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "supernova-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.js",
+  "type": "module",
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon src/server.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "dotenv": "^16.4.5",
+    "express": "^4.18.2"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.3",
+    "prettier": "^3.2.5"
+  }
+}

package/templates/js/src/server.js

@@ -0,0 +1,24 @@
+import express from "express";
+import cors from "cors";
+import dotenv from "dotenv";
+
+dotenv.config({
+    path: './.env'
+});
+
+const app = express();
+
+app.use(cors({
+    origin: process.env.CORS_ORIGIN,
+    credentials: true
+}));
+
+app.use(express.json({limit: "16kb"}));
+app.use(express.urlencoded({extended: true, limit: "16kb"}));
+
+// routes declaration
+
+
+app.listen(process.env.PORT || 5000, () => {
+    console.log(`⚙️ Server is running at port : ${process.env.PORT || 5000}`);
+});

package/templates/ts/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "supernova-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.ts",
+  "type": "module",
+  "scripts": {
+    "start": "node dist/server.js",
+    "dev": "tsx watch src/server.ts",
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "dotenv": "^16.4.5",
+    "express": "^4.18.2"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.10.0",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.2",
+    "prettier": "^3.2.5"
+  }
+}

package/templates/ts/src/server.ts

@@ -0,0 +1,25 @@
+import express, { Express } from "express";
+import cors from "cors";
+import dotenv from "dotenv";
+
+dotenv.config({
+    path: './.env'
+});
+
+const app: Express = express();
+
+app.use(cors({
+    origin: process.env.CORS_ORIGIN,
+    credentials: true
+}));
+
+app.use(express.json({limit: "16kb"}));
+app.use(express.urlencoded({extended: true, limit: "16kb"}));
+
+
+// routes declaration
+
+
+app.listen(process.env.PORT || 5000, () => {
+    console.log(`⚙️ Server is running at port : ${process.env.PORT || 5000}`);
+});

package/templates/ts/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "baseUrl": "./src",
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"]
+}