instant-express 1.0.0

package/README.md

@@ -0,0 +1,166 @@
+<p align="center">
+  <h1 align="center">⚡ instant-express</h1>
+  <p align="center">Generate a production-ready Express.js + MongoDB backend in seconds.</p>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/instant-express"><img src="https://img.shields.io/npm/v/instant-express?color=blue&label=npm" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/instant-express"><img src="https://img.shields.io/npm/dm/instant-express?color=green" alt="npm downloads"></a>
+  <a href="https://github.com/prashantdevelopment/gen-server/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/instant-express?color=yellow" alt="license"></a>
+  <a href="https://github.com/prashantdevelopment/gen-server"><img src="https://img.shields.io/github/stars/prashantdevelopment/gen-server?style=social" alt="GitHub stars"></a>
+</p>
+
+---
+
+## 🚀 Quick Start
+
+No installation needed. Just run:
+
+```bash
+npx instant-express my-project
+```
+
+That's it! Your backend is ready. 🎉
+
+---
+
+## 🎬 Demo
+
+```bash
+$ npx instant-express my-app
+
+🚀 Instant-Express CLI
+
+? Enter port number: 5000
+? Include JWT Authentication? Yes
+? Run npm install automatically? Yes
+
+📁 Folder created: my-app/
+✅ Core files generated!
+✅ Auth files generated (User model, controller, routes, middleware)!
+✅ package.json created!
+✅ .env file created!
+📦 Installing dependencies...
+✅ Dependencies installed successfully!
+
+🎉 my-app successfully generated!
+
+Next steps:
+  cd my-app
+  npm run dev
+
+Happy coding! 🚀
+```
+
+---
+
+## ✨ Features
+
+| Feature | Description |
+|---------|-------------|
+| ⚡ **One Command Setup** | `npx instant-express my-app` — full backend ready in seconds |
+| 🔐 **Optional JWT Auth** | Signup, Login, Logout with protected routes — choose at runtime |
+| 🧠 **Smart Dependencies** | Auth packages (`bcryptjs`, `jsonwebtoken`) only install when needed |
+| 🛡️ **DNS Fix Built-in** | MongoDB Atlas DNS issues auto-resolved with Google & Cloudflare DNS |
+| 📦 **Auto npm install** | Dependencies installed automatically — skip if you prefer manual |
+| 🗂️ **MVC Architecture** | Clean folder structure — config, controllers, routes, middlewares, models, services, utils |
+| 🎯 **Interactive CLI** | No config files needed — just answer simple prompts |
+| 📝 **Auto-generated files** | `.env`, `.env.example`, `.gitignore`, `package.json` — all ready |
+
+---
+
+## 🎯 Generated Project Structure
+
+```
+my-project/
+├── config/
+│   └── db.js                  # MongoDB connection with DNS fix
+├── controllers/
+│   └── authController.js      # Signup, Login, Logout (if auth selected)
+├── middlewares/
+│   └── authMiddleware.js      # JWT token verification (if auth selected)
+├── models/
+│   └── User.js                # User schema with bcrypt (if auth selected)
+├── routes/
+│   └── authRoutes.js          # Auth API routes (if auth selected)
+├── services/                  # Business logic (empty — ready for you)
+├── utils/                     # Helper functions (empty — ready for you)
+├── app.js                     # Express app setup with middlewares
+├── server.js                  # Server entry point
+├── .env                       # Environment variables (auto-generated)
+├── .env.example               # Environment template for reference
+├── .gitignore                 # Git ignore rules
+└── package.json               # Project config with all dependencies
+```
+
+---
+
+## ⚙️ CLI Options
+
+| Prompt | Description | Default |
+|--------|-------------|---------|
+| Port number | Server will run on this port | `5000` |
+| JWT Authentication | Include signup/login/logout with JWT | `Yes` |
+| Auto npm install | Install dependencies automatically | `Yes` |
+
+---
+
+## 🛡️ MongoDB DNS Fix (Built-in)
+
+Many developers face `querySrv ESERVFAIL` or `ENOTFOUND` errors when connecting to **MongoDB Atlas** — especially on certain ISPs.
+
+instant-express **automatically configures** reliable DNS resolvers in the generated `db.js`:
+
+```javascript
+import dns from 'dns';
+dns.setServers(['1.1.1.1', '8.8.8.8']); // Cloudflare + Google DNS
+```
+
+No more connection issues. It just works. ✅
+
+---
+
+## 🚀 After Generation
+
+```bash
+cd my-project
+npm run dev
+```
+
+**Output:**
+```
+✅ MongoDB Connected: localhost
+🚀 Server running on port 5000
+```
+
+### API Endpoints (if auth selected)
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST | `/api/auth/signup` | Register a new user |
+| POST | `/api/auth/login` | Login and get JWT token |
+| POST | `/api/auth/logout` | Logout (protected route) |
+
+---
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!
+
+1. Fork the repo
+2. Create your branch (`git checkout -b feature/awesome-feature`)
+3. Commit changes (`git commit -m 'Add awesome feature'`)
+4. Push (`git push origin feature/awesome-feature`)
+5. Open a Pull Request
+
+---
+
+## 📄 License
+
+MIT © [Prashant](https://github.com/prashantdevelopment)
+
+---
+
+<p align="center">
+  Made with ❤️ by <a href="https://github.com/prashantdevelopment">Prashant</a>
+</p>

package/index.js

@@ -0,0 +1,258 @@
+#!/usr/bin/env node
+
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import ora from 'ora';
+import fs from 'fs-extra';
+import path from 'path';
+import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
+
+const projectName = process.argv[2];
+
+// ES modules support for __dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Project name validation
+function isValidProjectName(name) {
+  const validPattern = /^[a-z0-9_-]+$/;
+  return validPattern.test(name) && name.length > 0 && name.length <= 50;
+}
+
+if (!projectName) {
+  console.log(chalk.red("Please provide a project name!"));
+  console.log(chalk.yellow("Usage: npx instant-express <project-name>"));
+  process.exit(1);
+}
+
+if (!isValidProjectName(projectName)) {
+  console.log(chalk.red("\n Invalid project name!"));
+  console.log(chalk.yellow("Rules:"));
+  console.log(chalk.yellow("  - Only lowercase letters, numbers, hyphens (-), underscores (_)"));
+  console.log(chalk.yellow("  - No spaces allowed"));
+  console.log(chalk.yellow("  - Example: my-cool-project, backend_v2"));
+  process.exit(1);
+}
+
+// Interactive prompts
+const questions = [
+  {
+    type: 'input',
+    name: 'port',
+    message: 'Enter port number:',
+    default: '5000',
+  },
+  {
+    type: 'confirm',
+    name: 'useAuth',
+    message: 'Include JWT Authentication?',
+    default: true,
+  },
+  {
+    type: 'confirm',
+    name: 'runInstall',
+    message: 'Run npm install automatically?',
+    default: true,
+  }
+];
+
+// Replace placeholders with actual values in template content
+function replacePlaceholders(content, replacements) {
+  let result = content;
+  for (const [placeholder, value] of Object.entries(replacements)) {
+    // Handle commented placeholders (// {{KEY}}) as well
+    const commentedRegex = new RegExp(`//\\s*{{${placeholder}}}`, 'g');
+    if (commentedRegex.test(result)) {
+      result = result.replace(commentedRegex, value);
+    } else {
+      const regex = new RegExp(`{{${placeholder}}}`, 'g');
+      result = result.replace(regex, value);
+    }
+  }
+  return result;
+}
+
+// Read template file, replace placeholders, and write to target
+function processTemplate(templatePath, targetPath, replacements) {
+  const content = fs.readFileSync(
+    path.join(__dirname, 'templates', templatePath),
+    'utf-8'
+  );
+  const finalContent = replacePlaceholders(content, replacements);
+  fs.ensureFileSync(targetPath);
+  fs.writeFileSync(targetPath, finalContent);
+}
+
+// Package.json structure for the generated project
+function createProjectPackageJson(projectName, dependencies) {
+  return {
+    name: projectName,
+    version: "1.0.0",
+    description: `${projectName} - Generated by instant-express`,
+    main: "server.js",
+    type: "module",
+    scripts: {
+      start: "node server.js",
+      dev: "nodemon server.js",
+    },
+    keywords: [],
+    author: "",
+    license: "ISC",
+    dependencies: dependencies,
+    devDependencies: {
+      nodemon: "^3.0.0",
+    },
+  };
+}
+
+// Main function
+async function main() {
+  const targetDir = path.join(process.cwd(), projectName);
+
+  // Check if folder already exists
+  if (fs.existsSync(targetDir)) {
+    console.log(chalk.red(`\n Error: Folder "${projectName}" already exists!`));
+    console.log(chalk.yellow("Solutions:"));
+    console.log(chalk.yellow("  1. Choose a different project name"));
+    console.log(chalk.yellow("  2. Delete the existing folder: rm -rf " + projectName));
+    process.exit(1);
+  }
+
+  console.log(chalk.blue.bold("\n🚀 Instant-Express CLI\n"));
+
+  // Collect user answers
+  const answers = await inquirer.prompt(questions);
+
+  // Placeholders mapping
+  const replacements = {
+    PROJECT_NAME: projectName,
+    PORT: answers.port,
+    AUTH_IMPORT: answers.useAuth
+      ? "import authRoutes from './routes/authRoutes.js';"
+      : '// No auth routes (auth was not selected)',
+    AUTH_ROUTE: answers.useAuth
+      ? "app.use('/api/auth', authRoutes);"
+      : '// No auth routes configured',
+  };
+
+  // Create target folder
+  fs.ensureDirSync(targetDir);
+  console.log(chalk.green(`\n📁 Folder created: ${projectName}/`));
+
+  // Generate core files
+  const coreFiles = [
+    { template: 'server.js', target: 'server.js' },
+    { template: 'app.js', target: 'app.js' },
+    { template: 'config/db.js', target: 'config/db.js' },
+    { template: '.env.example', target: '.env.example' },
+    { template: '.gitignore', target: '.gitignore' },
+  ];
+
+  for (const file of coreFiles) {
+    const targetPath = path.join(targetDir, file.target);
+    processTemplate(file.template, targetPath, replacements);
+  }
+  console.log(chalk.green("✅ Core files generated!"));
+
+  // Create empty folders with .gitkeep
+  const emptyFolders = ['services', 'utils'];
+  for (const folder of emptyFolders) {
+    const folderPath = path.join(targetDir, folder);
+    fs.ensureDirSync(folderPath);
+    fs.writeFileSync(path.join(folderPath, '.gitkeep'), '');
+  }
+
+  // Define dependencies
+  const baseDependencies = {
+    "express": "^4.18.2",
+    "mongoose": "^8.0.0",
+    "dotenv": "^16.3.1",
+    "cors": "^2.8.5",
+    "cookie-parser": "^1.4.6",
+    "morgan": "^1.10.0",
+  };
+
+  const authDependencies = {
+    "bcryptjs": "^2.4.3",
+    "jsonwebtoken": "^9.0.2",
+  };
+
+  const allDependencies = answers.useAuth
+    ? { ...baseDependencies, ...authDependencies }
+    : baseDependencies;
+
+  if (answers.useAuth) {
+    const authFiles = [
+      { template: 'models/User.js', target: 'models/User.js' },
+      { template: 'controllers/authController.js', target: 'controllers/authController.js' },
+      { template: 'routes/authRoutes.js', target: 'routes/authRoutes.js' },
+      { template: 'middlewares/authMiddleware.js', target: 'middlewares/authMiddleware.js' },
+    ];
+
+    for (const file of authFiles) {
+      const targetPath = path.join(targetDir, file.target);
+      processTemplate(file.template, targetPath, replacements);
+    }
+    console.log(chalk.green("✅ Auth files generated (User model, controller, routes, middleware)!"));
+  } else {
+    console.log(chalk.yellow("ℹ️  Auth skipped."));
+    fs.ensureDirSync(path.join(targetDir, 'models'));
+    fs.ensureDirSync(path.join(targetDir, 'controllers'));
+    fs.ensureDirSync(path.join(targetDir, 'routes'));
+    fs.ensureDirSync(path.join(targetDir, 'middlewares'));
+  }
+
+  // Write package.json for generated project
+  const projectPkg = createProjectPackageJson(projectName, allDependencies);
+  const pkgPath = path.join(targetDir, 'package.json');
+  fs.writeJsonSync(pkgPath, projectPkg, { spaces: 2 });
+  console.log(chalk.green("✅ package.json created!"));
+
+  // Generate .env file
+  const envContent = `PORT=${answers.port}
+MONGO_URI=mongodb://localhost:27017/${projectName}
+${answers.useAuth ? 'JWT_SECRET=change_this_to_a_random_secret_string\nJWT_EXPIRE=7d' : ''}
+`;
+  fs.writeFileSync(path.join(targetDir, '.env'), envContent.trim());
+  console.log(chalk.green("✅ .env file created!"));
+
+  // Auto run npm install
+  if (answers.runInstall) {
+    console.log(chalk.blue("\n📦 Installing dependencies..."));
+    const spinner = ora('Running npm install...').start();
+
+    try {
+      execSync('npm install', {
+        cwd: targetDir,
+        stdio: 'pipe',
+      });
+      spinner.succeed(chalk.green('Dependencies installed successfully! ✅'));
+    } catch (error) {
+      spinner.fail(chalk.red('npm install failed! ❌'));
+      console.log(chalk.yellow("Manual fix: cd " + projectName + " && npm install"));
+    }
+  } else {
+    console.log(chalk.yellow("\nℹ️  npm install skipped."));
+    console.log(chalk.yellow(`   Run manually: cd ${projectName} && npm install`));
+  }
+
+  // Success message
+  console.log(chalk.green.bold(`\n🎉 ${projectName} successfully generated!\n`));
+  console.log(chalk.white("Next steps:"));
+  console.log(chalk.cyan(`  cd ${projectName}`));
+  if (!answers.runInstall) {
+    console.log(chalk.cyan("  npm install"));
+  }
+  console.log(chalk.cyan("  npm run dev"));
+  console.log(chalk.white("\nHappy coding! 🚀\n"));
+}
+
+main().catch((err) => {
+  console.log(chalk.red(`\n❌ Unexpected error: ${err.message}`));
+  console.log(chalk.yellow("\nIf this error persists:"));
+  console.log(chalk.yellow("  1. Check if you have write permissions"));
+  console.log(chalk.yellow("  2. Restart your terminal"));
+  console.log(chalk.yellow("  3. Open an issue on GitHub with this error message"));
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "instant-express",
+  "version": "1.0.0",
+  "description": "CLI tool to instantly generate a production-ready Express.js + MongoDB backend with optional JWT authentication, folder structure, and auto dependency installation",
+  "main": "index.js",
+  "bin": {
+    "instant-express": "index.js"
+  },
+  "type": "module",
+  "files": [
+    "index.js",
+    "templates/",
+    "README.md"
+  ],
+  "keywords": [
+    "cli",
+    "express",
+    "mongodb",
+    "mongoose",
+    "boilerplate",
+    "generator",
+    "backend",
+    "nodejs",
+    "scaffold",
+    "starter",
+    "jwt",
+    "authentication",
+    "rest-api",
+    "api",
+    "express-generator",
+    "create-backend",
+    "project-generator"
+  ],
+  "author": "Prashant <imprashant16006@gmail.com> (https://github.com/prashantdevelopment)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prashantdevelopment/instant-express.git"
+  },
+  "homepage": "https://github.com/prashantdevelopment/instant-express#readme",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "fs-extra": "^11.3.5",
+    "inquirer": "^14.0.2",
+    "ora": "^9.4.0"
+  }
+}

package/templates/.env.example

@@ -0,0 +1,4 @@
+PORT={{PORT}}
+MONGO_URI=mongodb://localhost:27017/{{PROJECT_NAME}}
+JWT_SECRET=your_jwt_secret_here_change_this
+JWT_EXPIRE=7d

package/templates/app.js

@@ -0,0 +1,25 @@
+import express from 'express';
+import cors from 'cors';
+import cookieParser from 'cookie-parser';
+import morgan from 'morgan';
+
+// {{AUTH_IMPORT}}
+
+const app = express();
+
+// Built-in middlewares
+app.use(express.json());              // JSON body parse karne ke liye
+app.use(express.urlencoded({ extended: true })); // Form data ke liye
+app.use(cors());                       // Cross-origin requests allow karne ke liye
+app.use(cookieParser());              // Cookies read karne ke liye
+app.use(morgan('dev'));               // HTTP request logging ke liye
+
+// Routes
+// {{AUTH_ROUTE}}
+
+// Health check route
+app.get('/', (req, res) => {
+  res.json({ message: '{{PROJECT_NAME}} API is running 🚀' });
+});
+
+export default app;

package/templates/config/db.js

@@ -0,0 +1,17 @@
+import mongoose from 'mongoose';
+import dns from 'dns';
+
+// DNS resolver set karo taaki MongoDB Atlas ke DNS issues na aayein
+dns.setServers(['1.1.1.1', '8.8.8.8']);
+
+const connectDB = async () => {
+  try {
+    const conn = await mongoose.connect(process.env.MONGO_URI);
+    console.log(`✅ MongoDB Connected: ${conn.connection.host}`);
+  } catch (error) {
+    console.error(`❌ MongoDB Connection Error: ${error.message}`);
+    process.exit(1);
+  }
+};
+
+export default connectDB;

package/templates/controllers/authController.js

@@ -0,0 +1,61 @@
+import User from '../models/User.js';
+import jwt from 'jsonwebtoken';
+
+// JWT token generate karne ka helper
+const generateToken = (userId) => {
+  return jwt.sign({ id: userId }, process.env.JWT_SECRET, {
+    expiresIn: process.env.JWT_EXPIRE || '7d',
+  });
+};
+
+// Signup
+export const signup = async (req, res) => {
+  try {
+    const { name, email, password } = req.body;
+
+    // Check agar user already exist karta hai
+    const existingUser = await User.findOne({ email });
+    if (existingUser) {
+      return res.status(400).json({ message: 'User already exists' });
+    }
+
+    const user = await User.create({ name, email, password });
+    const token = generateToken(user._id);
+
+    res.status(201).json({
+      success: true,
+      token,
+      user: { id: user._id, name: user.name, email: user.email },
+    });
+  } catch (error) {
+    res.status(500).json({ message: error.message });
+  }
+};
+
+// Login
+export const login = async (req, res) => {
+  try {
+    const { email, password } = req.body;
+
+    // User dhoondho aur password bhi laao (+password kyunki select: false hai)
+    const user = await User.findOne({ email }).select('+password');
+    if (!user || !(await user.comparePassword(password))) {
+      return res.status(401).json({ message: 'Invalid email or password' });
+    }
+
+    const token = generateToken(user._id);
+
+    res.status(200).json({
+      success: true,
+      token,
+      user: { id: user._id, name: user.name, email: user.email },
+    });
+  } catch (error) {
+    res.status(500).json({ message: error.message });
+  }
+};
+
+// Logout
+export const logout = async (req, res) => {
+  res.status(200).json({ success: true, message: 'Logged out successfully' });
+};

package/templates/middlewares/authMiddleware.js

@@ -0,0 +1,31 @@
+import jwt from 'jsonwebtoken';
+import User from '../models/User.js';
+
+export const protect = async (req, res, next) => {
+  const token = req.cookies.token;
+
+  if (!token) {
+    return res.status(401).json({ message: 'Unauthorized: No token provided' });
+  }
+
+  if (!process.env.JWT_SECRET) {
+    console.error('CRITICAL ERROR: JWT_SECRET is not defined in environment variables');
+    return res.status(500).json({ message: 'Internal server error' });
+  }
+
+  try {
+    const decoded = jwt.verify(token, process.env.JWT_SECRET);
+    
+    
+    const user = await User.findById(decoded.id);
+    if (!user) {
+      return res.status(401).json({ message: 'Unauthorized: User not found' });
+    }
+    
+    req.user = user; // User mil gaya! Usse request object mein save kar do
+    next();
+  } catch (error) {
+    console.error('JWT Verification Error:', error.message);
+    res.status(401).json({ message: 'Unauthorized: Invalid token' });
+  }
+};

package/templates/models/User.js

@@ -0,0 +1,36 @@
+import mongoose from 'mongoose';
+import bcrypt from 'bcryptjs';
+
+const userSchema = new mongoose.Schema({
+  name: {
+    type: String,
+    required: [true, 'Name is required'],
+  },
+  email: {
+    type: String,
+    required: [true, 'Email is required'],
+    unique: true,
+    lowercase: true,
+  },
+  password: {
+    type: String,
+    required: [true, 'Password is required'],
+    minlength: 6,
+    select: false, // Password default mein query result mein nahi aayega
+  },
+}, { timestamps: true });
+
+// Password hash karo save se pehle
+userSchema.pre('save', async function(next) {
+  if (!this.isModified('password')) return next();
+  this.password = await bcrypt.hash(this.password, 12);
+  next();
+});
+
+// Password compare method
+userSchema.methods.comparePassword = async function(candidatePassword) {
+  return await bcrypt.compare(candidatePassword, this.password);
+};
+
+const User = mongoose.model('User', userSchema);
+export default User;

package/templates/routes/authRoutes.js

@@ -0,0 +1,11 @@
+import express from 'express';
+import { signup, login, logout } from '../controllers/authController.js';
+import { protect } from '../middlewares/authMiddleware.js';
+
+const router = express.Router();
+
+router.post('/signup', signup);
+router.post('/login', login);
+router.post('/logout', protect, logout); // Sirf logged-in user logout kar sake
+
+export default router;

package/templates/server.js

@@ -0,0 +1,12 @@
+import 'dotenv/config';
+import app from './app.js';
+import connectDB from './config/db.js';
+
+const PORT = process.env.PORT || '{{PORT}}';
+
+// Pehle database connect karo, phir server start karo
+connectDB().then(() => {
+  app.listen(PORT, () => {
+    console.log(`🚀 Server running on port ${PORT}`);
+  });
+});