express-backend-starter 1.0.1

package/README.md

@@ -0,0 +1,236 @@
+# 🚀 Express Backend Starter CLI
+
+A production-ready CLI tool to scaffold Express.js/Node.js backend projects in seconds.
+
+![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## ✨ Features
+
+- 🎯 **Interactive Setup** - Guided prompts for project configuration
+- 🗄️ **Multiple Databases** - MongoDB, PostgreSQL, or MySQL support
+- 📚 **Swagger Docs** - Auto-generated API documentation
+- ✅ **Zod Validation** - Type-safe request validation
+- 📧 **Email Support** - Nodemailer integration
+- 🔒 **Security First** - Helmet, CORS, rate limiting, JWT auth
+- 📁 **Clean Architecture** - Professional folder structure
+- ⚡ **Production Ready** - Best practices built-in
+
+## 🚀 Quick Start
+
+### Using npx (Recommended)
+
+```bash
+npx express-backend-starter
+```
+
+### Or Install Globally
+
+```bash
+npm install -g express-backend-starter
+express-backend-starter
+```
+
+## 📋 What Gets Generated?
+
+### Always Included
+
+- ✅ Express.js server setup
+- ✅ JWT authentication middleware
+- ✅ Error handling middleware
+- ✅ CORS configuration
+- ✅ Rate limiting
+- ✅ Helmet security headers
+- ✅ Cookie parser
+- ✅ Bcrypt password hashing
+- ✅ File upload with Multer
+- ✅ Environment configuration
+- ✅ Professional folder structure
+
+### Database Options
+
+- **MongoDB** → Mongoose ORM
+- **PostgreSQL** → Prisma ORM
+- **MySQL** → Prisma ORM
+
+### Optional Features
+
+- 📚 **Swagger** → API documentation UI
+- ✅ **Zod** → Runtime validation
+- 📧 **Nodemailer** → Email functionality
+
+## 🎬 Demo
+
+```bash
+$ npx express-backend-starter
+
+🚀 Welcome to Express Backend Starter CLI
+
+Let's scaffold your backend project...
+
+? What is your project name? my-awesome-api
+? Which database do you want to use? MongoDB
+? Include Swagger documentation? Yes
+? Include Zod validation? Yes
+? Include Nodemailer for email functionality? No
+
+✅ Project created successfully!
+
+Next steps:
+  cd my-awesome-api
+  npm run dev
+
+Happy coding! 🎉
+```
+
+## 📁 Generated Project Structure
+
+```
+my-awesome-api/
+├── .env.example
+├── .gitignore
+├── README.md
+├── package.json
+└── src/
+    ├── app.js                    # Main application
+    ├── config/
+    │   ├── db.js                 # Database connection
+    │   └── swagger.js            # Swagger config (optional)
+    ├── controllers/
+    │   └── healthController.js   # Sample controller
+    ├── middleware/
+    │   ├── auth.js              # JWT authentication
+    │   └── errorHandler.js      # Global error handler
+    ├── models/
+    │   └── User.js              # Sample model
+    ├── routes/
+    │   └── healthRoutes.js      # Sample routes
+    ├── services/                 # Business logic
+    └── utils/
+        └── validation.js         # Zod schemas (optional)
+```
+
+## 🛠️ Tech Stack
+
+- **Framework:** Express.js
+- **Authentication:** JWT (jsonwebtoken)
+- **Security:** Helmet, CORS, express-rate-limit
+- **Password Hashing:** bcryptjs
+- **File Upload:** Multer
+- **Database ORMs:** Mongoose (MongoDB) or Prisma (PostgreSQL/MySQL)
+- **Documentation:** Swagger (optional)
+- **Validation:** Zod (optional)
+- **Email:** Nodemailer (optional)
+
+## 📖 Usage
+
+### 1. Run the CLI
+
+```bash
+npx express-backend-starter
+```
+
+### 2. Answer the Prompts
+
+The CLI will ask you:
+- Project name
+- Database choice (MongoDB/PostgreSQL/MySQL)
+- Include Swagger? (y/n)
+- Include Zod? (y/n)
+- Include Nodemailer? (y/n)
+
+### 3. Navigate to Your Project
+
+```bash
+cd your-project-name
+```
+
+### 4. Configure Environment
+
+```bash
+cp .env.example .env
+# Edit .env with your settings
+```
+
+### 5. For Prisma (PostgreSQL/MySQL)
+
+```bash
+npx prisma migrate dev
+npx prisma generate
+```
+
+### 6. Start Development
+
+```bash
+npm run dev
+```
+
+Your server will be running at `http://localhost:5000`
+
+## 🌐 API Endpoints
+
+Generated project includes:
+
+- `GET /` - Welcome message
+- `GET /api/health` - Health check
+- `GET /api/health/info` - Server info
+- `GET /api-docs` - Swagger UI (if enabled)
+
+## 🔧 Available Scripts
+
+```json
+{
+  "dev": "nodemon src/app.js",    // Development with auto-reload
+  "start": "node src/app.js"       // Production start
+}
+```
+
+## 🔐 Environment Variables
+
+The generated `.env.example` includes:
+
+```env
+PORT=5000
+NODE_ENV=development
+JWT_SECRET=your_secret_key
+JWT_EXPIRE=7d
+
+# Database URLs (based on your choice)
+MONGO_URI=mongodb://localhost:27017/dbname
+# or
+DATABASE_URL=postgresql://user:pass@localhost:5432/dbname
+
+# Optional
+EMAIL_HOST=smtp.gmail.com
+EMAIL_USER=your@email.com
+# ... and more
+```
+
+## 📚 Documentation
+
+For detailed development guide, see [devGuide.md](./devGuide.md)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+MIT License - see LICENSE file for details
+
+## 🙏 Credits
+
+Built with:
+- [Commander.js](https://github.com/tj/commander.js)
+- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js)
+- [Chalk](https://github.com/chalk/chalk)
+- [Ora](https://github.com/sindresorhus/ora)
+- [Execa](https://github.com/sindresorhus/execa)
+
+## 💬 Support
+
+If you have any questions or issues, please open an issue on GitHub.
+
+---
+
+**Made with ❤️ for the Node.js community**

package/bin/cli.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+
+/**
+ * Express Backend Starter CLI
+ * Main entry point for the CLI tool
+ */
+
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { getUserInput } from '../src/prompts.js';
+import { installDependencies } from '../src/installers.js';
+import { generateProject } from '../src/generators.js';
+import ora from 'ora';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs-extra';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Read package.json for version
+const packageJson = JSON.parse(
+  await fs.readFile(path.join(__dirname, '../package.json'), 'utf-8')
+);
+
+const program = new Command();
+
+program
+  .name('express-backend-starter')
+  .description('Scaffold a production-ready Express.js/Node.js backend project')
+  .version(packageJson.version)
+  .action(async () => {
+    console.log(chalk.cyan.bold('\n🚀 Welcome to Express Backend Starter CLI\n'));
+    console.log(chalk.gray('Let\'s scaffold your backend project...\n'));
+
+    try {
+      // Step 1: Get user input through interactive prompts
+      const spinner = ora('Preparing questions...').start();
+      spinner.succeed('Ready!');
+
+      const answers = await getUserInput();
+
+      // Step 2: Create project directory
+      const projectPath = path.join(process.cwd(), answers.projectName);
+      
+      const creatingSpinner = ora('Creating project directory...').start();
+      
+      if (await fs.pathExists(projectPath)) {
+        creatingSpinner.fail(chalk.red(`Directory "${answers.projectName}" already exists!`));
+        process.exit(1);
+      }
+
+      await fs.ensureDir(projectPath);
+      creatingSpinner.succeed(chalk.green('Project directory created'));
+
+      // Step 3: Initialize npm project
+      const initSpinner = ora('Initializing npm project...').start();
+      await fs.writeJSON(path.join(projectPath, 'package.json'), {
+        name: answers.projectName,
+        version: '1.0.0',
+        description: 'Backend project generated by Express Backend Starter CLI',
+        main: 'src/app.js',
+        type: 'module',
+        scripts: {
+          dev: 'nodemon src/app.js',
+          start: 'node src/app.js'
+        },
+        keywords: [],
+        author: '',
+        license: 'ISC'
+      }, { spaces: 2 });
+      initSpinner.succeed(chalk.green('npm project initialized'));
+
+      // Step 4: Install dependencies
+      await installDependencies(projectPath, answers);
+
+      // Step 5: Generate project structure and files
+      await generateProject(projectPath, answers);
+
+      // Success message
+      console.log(chalk.green.bold('\n✅ Project created successfully!\n'));
+      console.log(chalk.cyan('Next steps:'));
+      console.log(chalk.white(`  cd ${answers.projectName}`));
+      
+      // Special instructions for Prisma databases
+      if (answers.database === 'postgresql' || answers.database === 'mysql') {
+        console.log(chalk.yellow('\n  📝 Configure your database:'));
+        console.log(chalk.white('  1. Update DATABASE_URL in .env file'));
+        console.log(chalk.white('  2. Run: npx prisma migrate dev'));
+        console.log(chalk.white('  3. Then: npm run dev\n'));
+      } else {
+        console.log(chalk.white('  npm run dev\n'));
+      }
+      
+      console.log(chalk.gray('Happy coding! 🎉\n'));
+
+    } catch (error) {
+      console.error(chalk.red.bold('\n❌ Error:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "express-backend-starter",
+  "version": "1.0.1",
+  "description": "A production-ready CLI tool to scaffold Express.js/Node.js backend projects",
+  "license": "MIT",
+  "author": "Aayush Sah",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "express-backend-starter": "./bin/cli.js"
+  },
+  "keywords": [
+    "express",
+    "backend",
+    "cli",
+    "scaffold",
+    "nodejs",
+    "generator",
+    "starter"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.3",
+    "inquirer": "^8.2.6",
+    "ora": "^9.1.0"
+  },
+  "files": [
+    "bin",
+    "src"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/db-config.js

@@ -0,0 +1,172 @@
+/**
+ * Database configuration templates
+ * Provides database connection setup for different databases
+ */
+
+/**
+ * Get database configuration based on database type
+ * @param {string} database - Database type (mongodb, postgresql, mysql)
+ * @returns {string} Database configuration code
+ */
+export function getDbConfig(database) {
+  switch (database) {
+    case 'mongodb':
+      return getMongoDbConfig();
+    
+    case 'postgresql':
+      return getPostgreSQLConfig();
+    
+    case 'mysql':
+      return getMySQLConfig();
+    
+    default:
+      return getMongoDbConfig();
+  }
+}
+
+/**
+ * MongoDB configuration with Mongoose
+ */
+function getMongoDbConfig() {
+  return `/**
+ * MongoDB Database Configuration
+ * Using Mongoose ORM
+ */
+
+import mongoose from 'mongoose';
+import chalk from 'chalk';
+
+/**
+ * Connect to MongoDB database
+ */
+export async function connectDB() {
+  try {
+    const conn = await mongoose.connect(process.env.MONGO_URI, {
+      // Mongoose 6+ no longer needs these options:
+      // useNewUrlParser: true,
+      // useUnifiedTopology: true,
+    });
+
+    console.log(chalk.green.bold(\`✅ MongoDB Connected: \${conn.connection.host}\`));
+    
+    // Connection events
+    mongoose.connection.on('error', (err) => {
+      console.error(chalk.red('MongoDB connection error:'), err);
+    });
+
+    mongoose.connection.on('disconnected', () => {
+      console.log(chalk.yellow('MongoDB disconnected'));
+    });
+
+    // Graceful shutdown
+    process.on('SIGINT', async () => {
+      await mongoose.connection.close();
+      console.log(chalk.yellow('MongoDB connection closed due to app termination'));
+      process.exit(0);
+    });
+
+  } catch (error) {
+    console.error(chalk.red.bold('❌ MongoDB connection failed:'), error.message);
+    process.exit(1);
+  }
+}
+`;
+}
+
+/**
+ * PostgreSQL configuration with Prisma
+ */
+function getPostgreSQLConfig() {
+  return `/**
+ * PostgreSQL Database Configuration
+ * Using Prisma ORM
+ */
+
+import { PrismaClient } from '@prisma/client';
+import chalk from 'chalk';
+
+// Initialize Prisma Client
+const prisma = new PrismaClient({
+  log: ['query', 'info', 'warn', 'error'],
+});
+
+/**
+ * Connect to PostgreSQL database
+ */
+export async function connectDB() {
+  try {
+    await prisma.$connect();
+    console.log(chalk.green.bold('✅ PostgreSQL Connected via Prisma'));
+
+    // Graceful shutdown
+    process.on('SIGINT', async () => {
+      await prisma.$disconnect();
+      console.log(chalk.yellow('PostgreSQL connection closed due to app termination'));
+      process.exit(0);
+    });
+
+    process.on('SIGTERM', async () => {
+      await prisma.$disconnect();
+      process.exit(0);
+    });
+
+  } catch (error) {
+    console.error(chalk.red.bold('❌ PostgreSQL connection failed:'), error.message);
+    await prisma.$disconnect();
+    process.exit(1);
+  }
+}
+
+// Export prisma instance for use in other modules
+export { prisma };
+`;
+}
+
+/**
+ * MySQL configuration with Prisma
+ */
+function getMySQLConfig() {
+  return `/**
+ * MySQL Database Configuration
+ * Using Prisma ORM
+ */
+
+import { PrismaClient } from '@prisma/client';
+import chalk from 'chalk';
+
+// Initialize Prisma Client
+const prisma = new PrismaClient({
+  log: ['query', 'info', 'warn', 'error'],
+});
+
+/**
+ * Connect to MySQL database
+ */
+export async function connectDB() {
+  try {
+    await prisma.$connect();
+    console.log(chalk.green.bold('✅ MySQL Connected via Prisma'));
+
+    // Graceful shutdown
+    process.on('SIGINT', async () => {
+      await prisma.$disconnect();
+      console.log(chalk.yellow('MySQL connection closed due to app termination'));
+      process.exit(0);
+    });
+
+    process.on('SIGTERM', async () => {
+      await prisma.$disconnect();
+      process.exit(0);
+    });
+
+  } catch (error) {
+    console.error(chalk.red.bold('❌ MySQL connection failed:'), error.message);
+    await prisma.$disconnect();
+    process.exit(1);
+  }
+}
+
+// Export prisma instance for use in other modules
+export { prisma };
+`;
+}

package/src/generators.js

@@ -0,0 +1,143 @@
+/**
+ * Project structure and file generation
+ * Creates folders and files for the new project
+ */
+
+import fs from 'fs-extra';
+import path from 'path';
+import ora from 'ora';
+import chalk from 'chalk';
+import { getDbConfig } from './db-config.js';
+import * as templates from './templates/index.js';
+
+/**
+ * Generate the complete project structure
+ * @param {string} projectPath - Path to the project directory
+ * @param {Object} answers - User's answers from prompts
+ */
+export async function generateProject(projectPath, answers) {
+  const spinner = ora('Generating project structure...').start();
+
+  try {
+    // Create folder structure
+    await createFolderStructure(projectPath);
+    spinner.text = 'Folder structure created';
+
+    // Generate configuration files
+    await generateConfigFiles(projectPath, answers);
+    spinner.text = 'Configuration files created';
+
+    // Generate source files
+    await generateSourceFiles(projectPath, answers);
+    spinner.text = 'Source files created';
+
+    // Generate README
+    await generateReadme(projectPath, answers);
+
+    spinner.succeed(chalk.green('Project structure generated'));
+  } catch (error) {
+    spinner.fail(chalk.red('Failed to generate project structure'));
+    throw error;
+  }
+}
+
+/**
+ * Create the folder structure
+ * @param {string} projectPath - Path to the project directory
+ */
+async function createFolderStructure(projectPath) {
+  const folders = [
+    'src',
+    'src/controllers',
+    'src/routes',
+    'src/middleware',
+    'src/config',
+    'src/services',
+    'src/models',
+    'src/utils'
+  ];
+
+  for (const folder of folders) {
+    await fs.ensureDir(path.join(projectPath, folder));
+  }
+}
+
+/**
+ * Generate configuration files
+ * @param {string} projectPath - Path to the project directory
+ * @param {Object} answers - User's answers
+ */
+async function generateConfigFiles(projectPath, answers) {
+  // .env.example
+  const envExample = templates.generateEnvExample(answers);
+  await fs.writeFile(path.join(projectPath, '.env.example'), envExample);
+
+  // .gitignore
+  const gitignore = templates.generateGitignore();
+  await fs.writeFile(path.join(projectPath, '.gitignore'), gitignore);
+
+  // Database configuration
+  const dbConfig = getDbConfig(answers.database);
+  await fs.writeFile(path.join(projectPath, 'src/config/db.js'), dbConfig);
+}
+
+/**
+ * Generate source files
+ * @param {string} projectPath - Path to the project directory
+ * @param {Object} answers - User's answers
+ */
+async function generateSourceFiles(projectPath, answers) {
+  // Main app.js
+  const appJs = templates.generateAppJs(answers);
+  await fs.writeFile(path.join(projectPath, 'src/app.js'), appJs);
+
+  // Sample controller
+  const sampleController = templates.generateSampleController();
+  await fs.writeFile(path.join(projectPath, 'src/controllers/healthController.js'), sampleController);
+
+  // Sample route
+  const sampleRoute = templates.generateSampleRoute();
+  await fs.writeFile(path.join(projectPath, 'src/routes/healthRoutes.js'), sampleRoute);
+
+  // Error middleware
+  const errorMiddleware = templates.generateErrorMiddleware();
+  await fs.writeFile(path.join(projectPath, 'src/middleware/errorHandler.js'), errorMiddleware);
+
+  // Auth middleware (JWT)
+  const authMiddleware = templates.generateAuthMiddleware();
+  await fs.writeFile(path.join(projectPath, 'src/middleware/auth.js'), authMiddleware);
+
+  // Swagger configuration (if selected)
+  if (answers.includeSwagger) {
+    const swaggerConfig = templates.generateSwaggerConfig(answers);
+    await fs.writeFile(path.join(projectPath, 'src/config/swagger.js'), swaggerConfig);
+  }
+
+  // Nodemailer configuration (if selected)
+  if (answers.includeNodemailer) {
+    const nodemailerConfig = templates.generateNodemailerConfig();
+    await fs.writeFile(path.join(projectPath, 'src/config/nodemailer.js'), nodemailerConfig);
+  }
+
+  // Zod validation example (if selected)
+  if (answers.includeZod) {
+    const zodExample = templates.generateZodValidation();
+    await fs.writeFile(path.join(projectPath, 'src/utils/validation.js'), zodExample);
+  }
+
+  // Sample model (database-specific)
+  if (answers.database === 'mongodb') {
+    const userModel = templates.generateMongooseModel();
+    await fs.writeFile(path.join(projectPath, 'src/models/User.js'), userModel);
+  }
+}
+
+/**
+ * Generate README.md
+ * @param {string} projectPath - Path to the project directory
+ * @param {Object} answers - User's answers
+ */
+async function generateReadme(projectPath, answers) {
+  const readme = templates.generateReadme(answers);
+  await fs.writeFile(path.join(projectPath, 'README.md'), readme);
+}