@apexkrrish/create-node-app 1.0.0

package/bin/cli.js

@@ -0,0 +1,218 @@
+#!/usr/bin/env node
+
+import { program } from 'commander';
+import inquirer from 'inquirer';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import ora from 'ora';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// ==========================================
+// Helper Functions
+// ==========================================
+
+async function promptUser(projectDirectory) {
+    let targetDir = projectDirectory;
+
+    if (!targetDir) {
+        const answers = await inquirer.prompt([
+            {
+                type: 'input',
+                name: 'projectDirectory',
+                message: 'What is your project named?',
+                default: 'my-app'
+            }
+        ]);
+        targetDir = answers.projectDirectory;
+    }
+
+    const { packageManager, database } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'packageManager',
+            message: 'Which package manager would you like to use?',
+            choices: ['npm', 'yarn', 'pnpm'],
+            default: 'npm'
+        },
+        {
+            type: 'list',
+            name: 'database',
+            message: 'Which database would you like to use?',
+            choices: ['MongoDB (Mongoose)', 'PostgreSQL (Sequelize)', 'None'],
+            default: 'MongoDB (Mongoose)'
+        }
+    ]);
+
+    return { targetDir, packageManager, database };
+}
+
+function copyTemplateFiles(templateDir, targetPath) {
+    const spinner = ora('Copying template files...').start();
+
+    if (fs.existsSync(targetPath)) {
+        spinner.fail(`Directory ${path.basename(targetPath)} already exists.`);
+        process.exit(1);
+    }
+
+    fs.mkdirSync(targetPath, { recursive: true });
+
+    const copyRecursiveSync = (src, dest) => {
+        const exists = fs.existsSync(src);
+        const stats = exists && fs.statSync(src);
+        if (exists && stats.isDirectory()) {
+            if (!fs.existsSync(dest)) fs.mkdirSync(dest);
+            fs.readdirSync(src).forEach((child) => {
+                if (child === 'node_modules') return;
+                copyRecursiveSync(path.join(src, child), path.join(dest, child));
+            });
+        } else {
+            fs.copyFileSync(src, dest);
+        }
+    };
+
+    try {
+        copyRecursiveSync(templateDir, targetPath);
+        spinner.succeed('Template copied successfully.');
+    } catch (err) {
+        spinner.fail('Failed to copy template.');
+        console.error(err);
+        process.exit(1);
+    }
+}
+
+function configureDatabase(targetPath, database) {
+    const packageJsonPath = path.join(targetPath, 'package.json');
+    if (!fs.existsSync(packageJsonPath)) return;
+
+    const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    pkg.name = path.basename(targetPath);
+
+    const dbConfigPath = path.join(targetPath, 'config', 'db.config.js');
+    const targetConfigDir = path.dirname(dbConfigPath);
+    if (!fs.existsSync(targetConfigDir)) {
+        fs.mkdirSync(targetConfigDir, { recursive: true });
+    }
+
+    if (database === 'MongoDB (Mongoose)') {
+        pkg.dependencies = pkg.dependencies || {};
+        pkg.dependencies.mongoose = '^8.0.0';
+
+        const mongooseContent = `import mongoose from "mongoose"
+
+const options = {
+    serverSelectionTimeoutMS: 10000,
+    dbName: '',
+}
+
+const connectDB = async () => {
+    try {
+        await mongoose.connect('', options)
+        console.log(\`✅ MongoDB connected!\`)
+    } catch (error) {
+        console.error(\`❌ MongoDB connection error: \${error.message}\`)
+        process.exit(1)
+    }
+}
+
+export default connectDB`;
+        fs.writeFileSync(dbConfigPath, mongooseContent);
+
+    } else if (database === 'PostgreSQL (Sequelize)') {
+        pkg.dependencies = pkg.dependencies || {};
+        pkg.dependencies.sequelize = '^6.35.0';
+        pkg.dependencies.pg = '^8.11.3';
+        pkg.dependencies.pg_hstore = '^2.3.4';
+
+        const sequelizeContent = `import { Sequelize } from "sequelize"
+
+export const sequelize = new Sequelize(
+    '',          // DB name
+    '',         // User
+    '',      // Password
+    {
+        host: '',
+        dialect: 'postgres',
+        logging: false,
+        port: ''
+    }
+) 
+
+// Test connection
+// (async () => {
+//     try {
+//         await sequelize.authenticate();
+//         console.log("PostgreSQL connected with Sequelize");
+//     } catch (err) {
+//         console.error("Error:", err.message);
+//     }
+// })()
+
+export default sequelize
+`;
+        fs.writeFileSync(dbConfigPath, sequelizeContent);
+
+    } else {
+        fs.writeFileSync(dbConfigPath, '// No database configured\n');
+    }
+
+    // Save updated package.json
+    fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2));
+}
+
+function installDependencies(targetPath, packageManager) {
+    const installSpinner = ora(`Installing dependencies using ${packageManager}...`).start();
+    try {
+        execSync(`${packageManager} install`, { cwd: targetPath, stdio: 'pipe' });
+        installSpinner.succeed('Dependencies installed successfully.');
+    } catch (err) {
+        installSpinner.fail('Failed to install dependencies.');
+        console.error(err);
+    }
+}
+
+function showSuccessMessage(targetDir, targetPath, packageManager) {
+    console.log(`\n${chalk.green('Success!')} Created ${path.basename(targetPath)} at ${targetPath}`);
+    console.log('\nInside that directory, you can run several commands:\n');
+    console.log(`  ${chalk.cyan(`${packageManager} run dev`)}`);
+    console.log('    Starts the development server with nodemon.\n');
+    console.log('We suggest that you begin by typing:\n');
+    console.log(`  ${chalk.cyan('cd')} ${targetDir}`);
+    console.log(`  ${chalk.cyan(`${packageManager} run dev`)}\n`);
+}
+
+// ==========================================
+// CLI Application
+// ==========================================
+
+program
+    .name('create-node-app')
+    .description('Scaffold a new Node.js application')
+    .argument('[project-directory]', 'Directory to create the project in')
+    .action(async (projectDirectory) => {
+
+        // 1. Prompt User
+        const { targetDir, packageManager, database } = await promptUser(projectDirectory);
+        const targetPath = path.resolve(process.cwd(), targetDir);
+        const templateDir = path.join(__dirname, '..', 'template');
+
+        console.log(`\nCreating a new Node.js app in ${chalk.green(targetPath)}\n`);
+
+        // 2. Copy Template Files
+        copyTemplateFiles(templateDir, targetPath);
+
+        // 3. Configure Database
+        configureDatabase(targetPath, database);
+
+        // 4. Install Dependencies
+        installDependencies(targetPath, packageManager);
+
+        // 5. Success Message
+        showSuccessMessage(targetDir, targetPath, packageManager);
+    });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@apexkrrish/create-node-app",
+    "version": "1.0.0",
+    "description": "A CLI tool to scaffold Node.js applications.",
+    "main": "index.js",
+    "type": "module",
+    "private": false,
+    "bin": {
+        "create-node-app": "bin/cli.js"
+    },
+    "scripts": {
+        "start": "node ./bin/cli.js"
+    },
+    "dependencies": {
+        "chalk": "^5.3.0",
+        "commander": "^12.0.0",
+        "inquirer": "^9.2.14",
+        "ora": "^8.0.1"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/KrishDhimanOfficial/create_node_app.git"
+    },
+    "keywords": [
+        "node",
+        "utility"
+    ],
+    "author": "",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/KrishDhimanOfficial/create_node_app/issues"
+    },
+    "homepage": "https://github.com/KrishDhimanOfficial/create_node_app#readme"
+}

package/readme.md

@@ -0,0 +1,51 @@
+# create-node-app
+
+A fast and interactive CLI tool to scaffold Node.js applications.
+
+## Features
+
+- **Interactive Prompts**: Choose your project name, package manager, and database just by answering simple questions.
+- **Multiple Package Managers**: Supports `npm`, `yarn`, and `pnpm`.
+- **Database Configuration**: Automatically configures database connections with pre-written boilerplate for:
+  - MongoDB (using Mongoose)
+  - PostgreSQL (using Sequelize)
+  - None (no database setup out-of-the-box)
+- **Ready to Go**: Automatically installs dependencies and sets up the basic folder structure based on the provided template.
+
+## Usage
+
+You can use the CLI directly:
+
+```bash
+npx create-node-app [project-directory]
+```
+
+Or, if you clone locally and link:
+
+```bash
+npm start -- my-new-project
+```
+
+### Interactive Prompts
+
+If you do not provide a project directory, the CLI will ask you for one. It will then prompt you to answer the following:
+
+1. **What is your project named?** (if no folder name was supplied)
+2. **Which package manager would you like to use?**
+   - npm
+   - yarn
+   - pnpm
+3. **Which database would you like to use?**
+   - MongoDB (Mongoose)
+   - PostgreSQL (Sequelize)
+   - None
+
+### After Setup
+
+Once the tool has finished scaffolding the project and installing dependencies, you can navigate into your new app and start the development server:
+
+```bash
+cd <your-project-directory>
+npm run dev
+```
+*(Replace `npm` with your chosen package manager!)*

package/template/app.js

@@ -0,0 +1,36 @@
+import express from 'express'
+import cookieParser from 'cookie-parser'
+import logger from 'morgan'
+import { globalErrorHandler } from './utils/helper.utils.js'
+import compression from 'compression'
+import cors from 'cors'
+import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const app = express()
+
+app.use(cors())
+app.use(logger('dev'))
+app.use(express.json({ limit: '10kb' }))
+app.use(express.urlencoded({ extended: true }))
+app.use(compression(
+  {
+    level: 4, // compression level
+    threshold: 0, // Compress all
+    memLevel: 9, // memory usuage
+    filter: (req, res) => compression.filter(req, res)
+  }
+))
+app.use(cookieParser())
+app.use(express.static(path.join(__dirname, 'public')))
+
+app.get('/', (req, res) => {
+  return res.send('Hello World!')
+})
+
+// error handler
+app.use(globalErrorHandler)
+
+export default app

package/template/bin/www

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+
+import app from '../app.js';
+import Debug from 'debug';
+const debug = Debug('create-node:server');
+import http from 'http';
+
+/**
+ * Get port from environment and store in Express.
+ */
+
+const port = normalizePort(process.env.PORT || '3000');
+app.set('port', port);
+
+/**
+ * Create HTTP server.
+ */
+
+const server = http.createServer(app);
+
+/**
+ * Listen on provided port, on all network interfaces.
+ */
+
+server.listen(port, () => {
+  console.log(`✅ Server is running on port ${port}`)
+})
+server.on('error', onError);
+server.on('listening', onListening);
+
+/**
+ * Normalize a port into a number, string, or false.
+ */
+
+function normalizePort(val) {
+  const port = parseInt(val, 10);
+
+  if (isNaN(port)) {
+    // named pipe
+    return val;
+  }
+
+  if (port >= 0) {
+    // port number
+    return port;
+  }
+
+  return false;
+}
+
+/**
+ * Event listener for HTTP server "error" event.
+ */
+
+function onError(error) {
+  if (error.syscall !== 'listen') {
+    throw error;
+  }
+
+  const bind = typeof port === 'string'
+    ? 'Pipe ' + port
+    : 'Port ' + port;
+
+  // handle specific listen errors with friendly messages
+  switch (error.code) {
+    case 'EACCES':
+      console.error(bind + ' requires elevated privileges');
+      process.exit(1);
+      break;
+    case 'EADDRINUSE':
+      console.error(bind + ' is already in use');
+      process.exit(1);
+      break;
+    default:
+      throw error;
+  }
+}
+
+/**
+ * Event listener for HTTP server "listening" event.
+ */
+
+function onListening() {
+  const addr = server.address();
+  const bind = typeof addr === 'string'
+    ? 'pipe ' + addr
+    : 'port ' + addr.port;
+  debug('Listening on ' + bind);
+}

package/template/config/config.js

@@ -0,0 +1,6 @@
+import dotenv from 'dotenv'
+dotenv.config({ quiet: true })
+
+export default {
+
+}

package/template/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "backend",
+  "version": "0.0.0",
+  "private": false,
+  "type": "module",
+  "scripts": {
+    "start": "node ./bin/www",
+    "dev": "nodemon ./bin/www"
+  },
+  "dependencies": {
+    "compression": "^1.8.1",
+    "cookie-parser": "~1.4.4",
+    "cors": "^2.8.6",
+    "debug": "~2.6.9",
+    "express": "^4.22.1",
+    "morgan": "^1.10.1"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.14"
+  }
+}

package/template/public/css/style.css

@@ -0,0 +1,8 @@
+body {
+  padding: 50px;
+  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
+}
+
+a {
+  color: #00B7FF;
+}

package/template/utils/helper.utils.js

@@ -0,0 +1,33 @@
+import { deleteFile } from './removeFile.utils.js'
+
+export const ApiError = (message, statusCode) => {
+    const error = new Error(message)
+    error.statusCode = statusCode
+    error.success = false
+    return error
+}
+
+export const asyncHandler = (fn, name = 'UnknownController') => {
+
+    return (req, res, next) => {
+        Promise.resolve(fn(req, res, next)).catch((err) => {
+            console.error(`🔥 Error in ${name} : ${err.message}`)
+            if (req.file?.filename) deleteFile(req.file?.path)
+            if (req.files && req.files?.length > 0) req.files?.forEach(file => deleteFile(file.path))
+            next(err)
+        })
+    }
+}
+
+export const globalErrorHandler = (err, req, res, next) => {
+    const statusCode = err.statusCode || 500;
+
+    // For API requests (JSON response)
+    return res.status(statusCode).json(
+        {
+            success: false,
+            message: err.message || 'Something went wrong',
+        }
+    )
+}
+

package/template/utils/removeFile.utils.js

@@ -0,0 +1,21 @@
+import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+import fs from 'node:fs'
+import chalk from 'chalk'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+
+const deleteFile = async (folderPath) => {
+    try {
+        const imagePath = path.join(__dirname, '..', folderPath)
+        if (!fs.existsSync(imagePath)) return
+
+        await fs.promises.rm(imagePath, { force: true })
+    } catch (error) {
+        console.error(chalk.red('deleteFile error:', error.message))
+    }
+}
+
+export { deleteFile }