create-xpress-backend 1.0.0

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "create-xpress-backend",
+  "version": "1.0.0",
+  "description": "Scaffold a production-ready Express + Prisma + PostgreSQL backend in seconds",
+  "main": "src/index.js",
+  "bin": {
+    "create-xpress-backend": "src/index.js"
+  },
+  "scripts": {
+    "start": "node src/index.js"
+  },
+  "keywords": [
+    "express",
+    "backend",
+    "scaffold",
+    "prisma",
+    "postgresql",
+    "cli",
+    "boilerplate",
+    "starter",
+    "generator",
+    "node"
+  ],
+  "author": "ayushsolanki29",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ayushsolanki29/create-xpress-backend.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ayushsolanki29/create-xpress-backend/issues"
+  },
+  "homepage": "https://github.com/ayushsolanki29/create-xpress-backend#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1"
+  }
+}

package/src/generator.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs-extra');
+const { execSync } = require('child_process');
+const { buildTemplates } = require('./templates');
+
+/**
+ * Main generator — writes every file into the new project directory.
+ * @param {object} answers - Inquirer answers
+ * @param {object} spinner - Ora spinner instance
+ */
+async function generateProject(answers, spinner) {
+  const { projectName, language, port, includeFileUpload, includeAuth, initGit } = answers;
+  const isTs = language === 'ts';
+  const destDir = path.resolve(process.cwd(), projectName);
+
+  // 1. Create root folder
+  spinner.text = 'Creating project folder...';
+  await fs.ensureDir(destDir);
+
+  // 2. Build all file contents from templates
+  const files = buildTemplates({ projectName, language, port, includeFileUpload, includeAuth });
+
+  // 3. Write every file
+  for (const [relPath, content] of Object.entries(files)) {
+    spinner.text = `Writing ${relPath}`;
+    const absPath = path.join(destDir, relPath);
+    await fs.ensureDir(path.dirname(absPath));
+    await fs.writeFile(absPath, content, 'utf8');
+  }
+
+  // 4. Create uploads dir placeholder if file upload included
+  if (includeFileUpload) {
+    await fs.ensureDir(path.join(destDir, 'uploads'));
+    await fs.writeFile(path.join(destDir, 'uploads', '.gitkeep'), '', 'utf8');
+  }
+
+  // 5. Git init
+  if (initGit) {
+    spinner.text = 'Initialising git...';
+    try {
+      execSync('git init', { cwd: destDir, stdio: 'ignore' });
+    } catch {
+      // git not available — not fatal
+    }
+  }
+}
+
+module.exports = { generateProject };

package/src/index.js

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const ora = require('ora');
+const path = require('path');
+const fs = require('fs-extra');
+
+const { generateProject } = require('./generator');
+
+const VERSION = require('../package.json').version;
+
+// ─── Banner ───────────────────────────────────────────────────────────────────
+function printBanner() {
+  console.log('');
+  console.log(chalk.bold.cyan('  ┌─────────────────────────────────────────────┐'));
+  console.log(
+    chalk.bold.cyan('  │') +
+    chalk.bold.white('  🚀  create-xpress-backend') +
+    chalk.gray(`  v${VERSION}`) +
+    chalk.bold.cyan('          │')
+  );
+  console.log(
+    chalk.bold.cyan('  │') +
+    chalk.dim('  Express · Prisma · PostgreSQL · Node.js     ') +
+    chalk.bold.cyan('│')
+  );
+  console.log(chalk.bold.cyan('  └─────────────────────────────────────────────┘'));
+  console.log('');
+}
+
+// ─── Prompts ──────────────────────────────────────────────────────────────────
+async function askQuestions() {
+  return inquirer.prompt([
+    {
+      type: 'input',
+      name: 'projectName',
+      message: chalk.cyan('project_name') + chalk.gray('          : '),
+      validate(input) {
+        const name = input.trim();
+        if (!name) return 'Project name cannot be empty.';
+        if (!/^[a-z0-9-_]+$/i.test(name))
+          return 'Use only letters, numbers, hyphens or underscores.';
+        if (fs.existsSync(path.resolve(process.cwd(), name)))
+          return `Folder "${name}" already exists — pick a different name.`;
+        return true;
+      },
+      filter: (v) => v.trim(),
+    },
+    {
+      type: 'list',
+      name: 'language',
+      message: chalk.cyan('language') + chalk.gray('             : '),
+      choices: [
+        { name: 'TypeScript  (recommended)', value: 'ts' },
+        { name: 'JavaScript', value: 'js' },
+      ],
+      default: 'ts',
+    },
+    {
+      type: 'input',
+      name: 'port',
+      message: chalk.cyan('port') + chalk.gray('                 : '),
+      default: '5050',
+      validate: (v) => (/^\d+$/.test(v.trim()) ? true : 'Port must be a number.'),
+      filter: (v) => v.trim(),
+    },
+    {
+      type: 'confirm',
+      name: 'includeFileUpload',
+      message: chalk.cyan('file upload system') + chalk.gray('   : include?'),
+      default: true,
+    },
+    {
+      type: 'confirm',
+      name: 'includeAuth',
+      message: chalk.cyan('JWT auth module') + chalk.gray('      : include?'),
+      default: false,
+    },
+    {
+      type: 'confirm',
+      name: 'initGit',
+      message: chalk.cyan('git init') + chalk.gray('             : initialize?'),
+      default: true,
+    },
+  ]);
+}
+
+// ─── Success output ───────────────────────────────────────────────────────────
+function printSuccess(projectName, port, language) {
+  const isTs = language === 'ts';
+
+  console.log('');
+  console.log(chalk.bold.green('  ✔ Done! Your project is ready.\n'));
+
+  console.log(chalk.bold('  Get started:'));
+  console.log(chalk.white(`    cd ${projectName}`));
+  console.log(chalk.white('    npm install'));
+  console.log(chalk.dim('    # configure DATABASE_URL in .env, then:'));
+  console.log(chalk.white('    npm run db:push'));
+  console.log(chalk.white('    npm run dev\n'));
+
+  if (isTs) {
+    console.log(chalk.dim('  Build for production:'));
+    console.log(chalk.white('    npm run build'));
+    console.log(chalk.white('    npm start\n'));
+  }
+
+  console.log(chalk.dim('  Health check  →  ') + chalk.cyan(`http://localhost:${port}/health`));
+  console.log(chalk.dim('  Prisma Studio →  ') + chalk.cyan('npm run db:studio'));
+  console.log('');
+}
+
+// ─── Main ─────────────────────────────────────────────────────────────────────
+async function main() {
+  printBanner();
+
+  let answers;
+  try {
+    answers = await askQuestions();
+  } catch {
+    console.log('\n' + chalk.yellow('  Cancelled.'));
+    process.exit(0);
+  }
+
+  console.log('');
+
+  const isTs = answers.language === 'ts';
+  const langLabel = isTs
+    ? chalk.blue('TypeScript')
+    : chalk.yellow('JavaScript');
+
+  const spinner = ora({
+    text: chalk.cyan(`Scaffolding ${chalk.bold(answers.projectName)} `) + chalk.gray(`[${langLabel}${chalk.gray(']')}...`),
+    color: 'cyan',
+  }).start();
+
+  try {
+    await generateProject(answers, spinner);
+    spinner.succeed(
+      chalk.green(`Project "${chalk.bold(answers.projectName)}" created! `) +
+      chalk.gray(`(${isTs ? 'TypeScript' : 'JavaScript'})`)
+    );
+    printSuccess(answers.projectName, answers.port, answers.language);
+  } catch (err) {
+    spinner.fail(chalk.red('Something went wrong.'));
+    console.error(chalk.red(`\n  ${err.message}\n`));
+    process.exit(1);
+  }
+}
+
+main();

package/src/templates/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const { buildJsTemplates } = require('./js');
+const { buildTsTemplates } = require('./ts');
+
+/**
+ * Routes to the correct template set based on chosen language.
+ */
+function buildTemplates(opts) {
+  return opts.language === 'ts'
+    ? buildTsTemplates(opts)
+    : buildJsTemplates(opts);
+}
+
+module.exports = { buildTemplates };