create-express-mongo-mvc 1.0.0

package/README.md

@@ -0,0 +1,48 @@
+Z# create-express-mongo-mvc
+
+Create a minimal Express + MongoDB (Mongoose) MVC boilerplate.
+
+## Usage
+
+```bash
+npx create-express-mongo-mvc my-app
+```
+
+Or, scaffold and install dependencies in one go:
+
+```bash
+npx create-express-mongo-mvc my-app --install
+```
+
+## What you get
+
+- Express app (`src/app.js`)
+- Server entry (`src/server.js`)
+- Mongo connection (`src/config/db.js`)
+- MVC folders (`controllers/`, `models/`, `routes/`)
+- Example `User` CRUD + `health` route
+
+## After scaffolding
+
+```bash
+cd my-app
+cp .env.example .env
+npm install
+npm run dev
+```
+
+## Publishing
+
+1. Login:
+
+```bash
+npm login
+```
+
+2. Publish:
+
+```bash
+npm publish
+```
+
+If you want `npx create-...` behavior, the package name should start with `create-`.

package/bin/create-express-mongo-mvc.js

@@ -0,0 +1,125 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+const { spawnSync } = require('child_process');
+
+const usage = () => {
+  console.log('Usage: create-express-mongo-mvc <project-name> [--install] [--skip-install]');
+};
+
+const parseArgs = (argv) => {
+  const args = [];
+  const flags = new Set();
+
+  for (const arg of argv) {
+    if (arg.startsWith('-')) {
+      flags.add(arg);
+    } else {
+      args.push(arg);
+    }
+  }
+
+  return {
+    projectName: args[0],
+    install: flags.has('--install'),
+    skipInstall: flags.has('--skip-install'),
+  };
+};
+
+const options = parseArgs(process.argv.slice(2));
+const projectName = options.projectName;
+
+if (!projectName) {
+  usage();
+  process.exit(1);
+}
+
+const templateDir = path.join(__dirname, '..', 'template');
+const targetDir = path.resolve(process.cwd(), projectName);
+
+const pathExists = async (p) => {
+  try {
+    await fs.promises.access(p);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const copyDir = async (srcDir, destDir) => {
+  await fs.promises.mkdir(destDir, { recursive: true });
+  const entries = await fs.promises.readdir(srcDir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    if (entry.name === 'node_modules') continue;
+
+    const src = path.join(srcDir, entry.name);
+    const dest = path.join(destDir, entry.name);
+
+    if (entry.isDirectory()) {
+      await copyDir(src, dest);
+      continue;
+    }
+
+    if (entry.isSymbolicLink()) {
+      const real = await fs.promises.readlink(src);
+      await fs.promises.symlink(real, dest);
+      continue;
+    }
+
+    await fs.promises.copyFile(src, dest);
+  }
+};
+
+const run = async () => {
+  if (await pathExists(targetDir)) {
+    console.error(`Target directory already exists: ${targetDir}`);
+    process.exit(1);
+  }
+
+  await copyDir(templateDir, targetDir);
+
+  const pkgPath = path.join(targetDir, 'package.json');
+  const pkg = JSON.parse(await fs.promises.readFile(pkgPath, 'utf8'));
+  pkg.name = projectName;
+  await fs.promises.writeFile(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
+
+  const envExamplePath = path.join(targetDir, '.env.example');
+  const envPath = path.join(targetDir, '.env');
+  if ((await pathExists(envExamplePath)) && !(await pathExists(envPath))) {
+    await fs.promises.copyFile(envExamplePath, envPath);
+  }
+
+  const shouldInstall = options.install && !options.skipInstall;
+
+  console.log('');
+  console.log(`Scaffolded project in: ${targetDir}`);
+  console.log('');
+  console.log('Next steps:');
+  console.log(`  cd ${projectName}`);
+
+  if (shouldInstall) {
+    console.log('  npm install');
+  }
+
+  console.log('  npm run dev');
+  console.log('');
+
+  if (shouldInstall) {
+    const res = spawnSync('npm', ['install'], {
+      cwd: targetDir,
+      stdio: 'inherit',
+      shell: process.platform === 'win32',
+    });
+
+    if (res.status !== 0) {
+      process.exit(res.status || 1);
+    }
+  }
+};
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "create-express-mongo-mvc",
+  "version": "1.0.0",
+  "description": "Create a minimal Express + MongoDB (Mongoose) MVC boilerplate",
+  "main": "bin/create-express-mongo-mvc.js",
+  "scripts": {
+    "start": "node bin/create-express-mongo-mvc.js",
+    "lint": "node -c bin/create-express-mongo-mvc.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "create-express-mongo-mvc": "bin/create-express-mongo-mvc.js"
+  },
+  "files": [
+    "bin/",
+    "template/"
+  ],
+  "dependencies": {},
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs"
+}

package/template/.env.example

@@ -0,0 +1,3 @@
+PORT=5001
+NODE_ENV=development
+MONGODB_URI=mongodb://127.0.0.1:27017/boilerplate

package/template/README.md

@@ -0,0 +1,20 @@
+# __APP_NAME__
+
+## Setup
+
+1. Create `.env` from `.env.example`
+2. Install dependencies
+3. Run the server
+
+```bash
+npm install
+npm run dev
+```
+
+## Endpoints
+
+- `GET /api/health`
+- `GET /api/users`
+- `POST /api/users`
+- `PUT /api/users/:id`
+- `DELETE /api/users/:id`

package/template/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "express-mongo-mvc-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.js",
+  "type": "commonjs",
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon src/server.js"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
+    "mongoose": "^8.9.5"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.9"
+  }
+}

package/template/src/app.js

@@ -0,0 +1,10 @@
+const express = require('express');
+
+const routes = require('./routes');
+
+const app = express();
+
+app.use(express.json());
+app.use('/api', routes);
+
+module.exports = app;

package/template/src/config/db.js

@@ -0,0 +1,12 @@
+const mongoose = require('mongoose');
+
+const connectDB = async () => {
+  const uri = process.env.MONGODB_URI;
+  if (!uri) {
+    throw new Error('MONGODB_URI is not set');
+  }
+
+  await mongoose.connect(uri);
+};
+
+module.exports = connectDB;

package/template/src/controllers/healthController.js

@@ -0,0 +1,7 @@
+const healthCheck = (req, res) => {
+  res.status(200).json({ status: 'ok' });
+};
+
+module.exports = {
+  healthCheck,
+};

package/template/src/controllers/userController.js

@@ -0,0 +1,63 @@
+const User = require('../models/User');
+
+const getUsers = async (req, res, next) => {
+  try {
+    const users = await User.find().sort({ createdAt: -1 });
+    res.status(200).json({ data: users });
+  } catch (err) {
+    next(err);
+  }
+};
+
+const createUser = async (req, res, next) => {
+  try {
+    const { name, email } = req.body;
+    const user = await User.create({ name, email });
+    res.status(201).json({ data: user });
+  } catch (err) {
+    next(err);
+  }
+};
+
+const updateUser = async (req, res, next) => {
+  try {
+    const { id } = req.params;
+    const { name, email } = req.body;
+
+    const user = await User.findByIdAndUpdate(
+      id,
+      { name, email },
+      { new: true, runValidators: true }
+    );
+
+    if (!user) {
+      return res.status(404).json({ message: 'User not found' });
+    }
+
+    res.status(200).json({ data: user });
+  } catch (err) {
+    next(err);
+  }
+};
+
+const deleteUser = async (req, res, next) => {
+  try {
+    const { id } = req.params;
+    const user = await User.findByIdAndDelete(id);
+
+    if (!user) {
+      return res.status(404).json({ message: 'User not found' });
+    }
+
+    res.status(200).json({ data: user });
+  } catch (err) {
+    next(err);
+  }
+};
+
+module.exports = {
+  getUsers,
+  createUser,
+  updateUser,
+  deleteUser,
+};

package/template/src/models/User.js

@@ -0,0 +1,21 @@
+const mongoose = require('mongoose');
+
+const userSchema = new mongoose.Schema(
+  {
+    name: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    email: {
+      type: String,
+      required: true,
+      unique: true,
+      lowercase: true,
+      trim: true,
+    },
+  },
+  { timestamps: true }
+);
+
+module.exports = mongoose.model('User', userSchema);

package/template/src/routes/healthRoutes.js

@@ -0,0 +1,9 @@
+const express = require('express');
+
+const { healthCheck } = require('../controllers/healthController');
+
+const router = express.Router();
+
+router.get('/', healthCheck);
+
+module.exports = router;

package/template/src/routes/index.js

@@ -0,0 +1,11 @@
+const express = require('express');
+
+const healthRoutes = require('./healthRoutes');
+const userRoutes = require('./userRoutes');
+
+const router = express.Router();
+
+router.use('/health', healthRoutes);
+router.use('/users', userRoutes);
+
+module.exports = router;

package/template/src/routes/userRoutes.js

@@ -0,0 +1,17 @@
+const express = require('express');
+
+const {
+  getUsers,
+  createUser,
+  updateUser,
+  deleteUser,
+} = require('../controllers/userController');
+
+const router = express.Router();
+
+router.get('/', getUsers);
+router.post('/', createUser);
+router.put('/:id', updateUser);
+router.delete('/:id', deleteUser);
+
+module.exports = router;

package/template/src/server.js

@@ -0,0 +1,19 @@
+require('dotenv').config();
+
+const app = require('./app');
+const connectDB = require('./config/db');
+
+const PORT = process.env.PORT || 5000;
+
+const start = async () => {
+  await connectDB();
+
+  app.listen(PORT, () => {
+    console.log(`Server listening on port ${PORT}`);
+  });
+};
+
+start().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});