create-nodets-app-nish 1.0.0

package/README.md

@@ -0,0 +1,161 @@
+# create-nodets-app-nish
+
+🚀 A command-line tool to create a new **Node.js + Express + MongoDB + TypeScript** project with best practices and sensible defaults.
+
+## Installation
+
+```bash
+npm create nodets-app-nish
+```
+
+Or with a project name:
+
+```bash
+npm create nodets-app-nish my-app
+```
+
+## Usage
+
+### Interactive Mode
+
+```bash
+npm create nodets-app-nish
+```
+
+You'll be prompted to enter your project name.
+
+### With Project Name
+
+```bash
+npm create nodets-app-nish my-awesome-app
+cd my-awesome-app
+npm install
+npm run dev
+```
+
+## What's Included
+
+The generated project includes:
+
+- ✨ **TypeScript** - Full TypeScript support out of the box
+- 🚀 **Express.js** - Fast and lightweight web framework
+- 🗄️ **MongoDB** - Document database with Mongoose ODM
+- 🔐 **Authentication** - JWT tokens with bcrypt password hashing
+- 📧 **Email Integration** - Nodemailer for email sending
+- 🏗️ **Clean Architecture** - Well-organized folder structure
+- ♻️ **Hot Reload** - Nodemon for development
+- 🏭 **Production Ready** - Build scripts for compilation
+
+## Package Contents
+
+```
+templates/
+└── nodejs-typescript/
+    ├── src/
+    │   ├── index.ts           # Entry point
+    │   ├── app.ts             # Express app config
+    │   ├── admin/             # Admin module
+    │   │   └── model.register.ts
+    │   ├── controllers/        # Route controllers
+    │   ├── db/                 # Database setup
+    │   ├── interface/          # TypeScript interfaces
+    │   ├── middlewares/        # Custom middlewares
+    │   ├── models/             # Mongoose models
+    │   ├── routers/            # API routes
+    │   └── utils/              # Helper functions
+    ├── package.json
+    ├── tsconfig.json
+    ├── .env.example
+    └── .gitignore
+
+bin/
+└── index.js                    # CLI entry point
+```
+
+## Getting Started with Generated Project
+
+```bash
+cd my-app
+npm install
+cp .env.example .env
+# Edit .env with your configuration
+npm run dev
+```
+
+### Available Scripts
+
+```bash
+npm run dev      # Start development server with hot reload
+npm run build    # Build TypeScript to JavaScript
+npm start        # Run compiled application
+```
+
+## Configuration
+
+The generated project includes a `.env.example` file. Copy it to `.env` and configure:
+
+```env
+PORT=3000
+MONGODB_URI=mongodb://localhost:27017/your-app
+JWT_SECRET=your-secret-key
+CORS_ORIGIN=http://localhost:3000
+
+# Email Configuration
+SMTP_HOST=smtp.gmail.com
+SMTP_PORT=587
+SMTP_USER=your-email@gmail.com
+SMTP_PASS=your-app-password
+SMTP_FROM=noreply@example.com
+```
+
+## Features
+
+### Admin Model with Authentication
+- User registration with password hashing (bcrypt)
+- JWT token generation
+- Password verification
+- MongoDB/Mongoose integration
+
+### Utility Functions
+- **apiResponse** - Standardized API response formatter
+- **asyncHandler** - Express async/await error handling
+- **login** - Login utility for different models
+- **sendMail** - Email sending via SMTP
+
+### Production Ready
+- TypeScript strict mode enabled
+- ESM modules support
+- Comprehensive tsconfig setup
+- Security best practices included
+
+## How It Works
+
+1. User runs `npm create nodets-app my-app`
+2. CLI prompts for project name
+3. Creates project directory
+4. Copies template files
+5. Updates package.json with project name
+6. Ready to install and develop!
+
+## Publishing to npm
+
+1. Create npm account at [npmjs.com](https://www.npmjs.com)
+2. Login locally: `npm login`
+3. Publish: `npm publish`
+
+After publishing, users can use your template:
+```bash
+npx create-nodets-app my-project
+```
+
+## License
+
+ISC
+
+## Author
+
+krish112407
+
+---
+
+Made with ❤️ for Node.js developers | Based on professional backend architecture

package/bin/index.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { stdin as input, stdout as output } from 'process';
+import readline from 'readline';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const templatesDir = path.join(__dirname, '..', 'templates');
+
+const rl = readline.createInterface({ input, output });
+
+function question(query) {
+  return new Promise((resolve) => {
+    rl.question(query, resolve);
+  });
+}
+
+async function main() {
+  try {
+    console.log('\n🚀 Welcome to create-nodets-app!\n');
+
+    // Get project name
+    let projectName = process.argv[2];
+    if (!projectName) {
+      projectName = await question('📁 Enter project name: ');
+    }
+
+    if (!projectName || projectName.trim() === '') {
+      console.error('❌ Project name is required!');
+      process.exit(1);
+    }
+
+    projectName = projectName.trim();
+
+    // Check if directory already exists
+    if (fs.existsSync(projectName)) {
+      console.error(`❌ Directory "${projectName}" already exists!`);
+      process.exit(1);
+    }
+
+    console.log(`\n✨ Creating project: ${projectName}`);
+
+    // Create project directory
+    fs.mkdirSync(projectName, { recursive: true });
+
+    // Copy template files
+    const templatePath = path.join(templatesDir, 'nodejs-typescript');
+    if (!fs.existsSync(templatePath)) {
+      console.error('❌ Template not found!');
+      process.exit(1);
+    }
+
+    fs.copySync(templatePath, projectName, { overwrite: false });
+
+    // Update package.json with project name
+    const packageJsonPath = path.join(projectName, 'package.json');
+    const packageJson = fs.readJsonSync(packageJsonPath);
+    packageJson.name = projectName;
+    packageJson.author = 'krish112407';
+    fs.writeJsonSync(packageJsonPath, packageJson, { spaces: 2 });
+
+    console.log(`\n✅ Project created successfully!\n`);
+    console.log(`📂 Project directory: ${projectName}`);
+    console.log(`\n🎯 Next steps:`);
+    console.log(`   1. cd ${projectName}`);
+    console.log(`   2. npm install`);
+    console.log(`   3. npm run dev\n`);
+
+    rl.close();
+  } catch (error) {
+    console.error('Error:', error.message);
+    rl.close();
+    process.exit(1);
+  }
+}
+
+main();

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "create-nodets-app-nish",
+  "version": "1.0.0",
+  "description": "Command line tool to create a new Node.js + Express + MongoDB + TypeScript project template",
+  "license": "ISC",
+  "author": "krish112407",
+  "type": "module",
+  "bin": {
+    "create-nodets-app-nish": "bin/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "keywords": [
+    "cli",
+    "create-app",
+    "node",
+    "typescript",
+    "template",
+    "generator",
+    "boilerplate",
+    "express",
+    "mongodb"
+  ],
+  "scripts": {
+    "dev": "node bin/index.js",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/krish112407/create-nodets-app.git"
+  },
+  "bugs": {
+    "url": "https://github.com/krish112407/create-nodets-app/issues"
+  },
+  "homepage": "https://github.com/krish112407/create-nodets-app#readme",
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "fs-extra": "^11.2.0"
+  }
+}

package/templates/nodejs-typescript/README.md

@@ -0,0 +1,156 @@
+# Node.js + Express + MongoDB + TypeScript Application
+
+A production-ready Node.js backend application built with Express, MongoDB, and TypeScript.
+
+## Features
+
+- ✨ **TypeScript** - Full type safety
+- 🚀 **Express.js** - Fast and lightweight web framework
+- 🗄️ **MongoDB** - NoSQL database with Mongoose ODM
+- 🔐 **Authentication** - JWT-based auth with bcrypt password hashing
+- 📧 **Email Service** - Nodemailer integration for sending emails
+- 🏗️ **Clean Architecture** - Well-organized folder structure
+- 🔥 **Hot Reload** - Nodemon for development
+
+## Prerequisites
+
+- Node.js 16+
+- MongoDB (local or cloud)
+- SMTP server credentials (Gmail, SendGrid, etc.)
+
+## Getting Started
+
+### Installation
+
+```bash
+npm install
+```
+
+### Setup Environment
+
+Copy `.env.example` to `.env` and configure your variables:
+
+```bash
+cp .env.example .env
+```
+
+Edit `.env` with your settings:
+- `MONGODB_URI` - MongoDB connection string
+- `JWT_SECRET` - Secret key for JWT tokens
+- `SMTP_*` - Email service credentials
+
+### Development
+
+Start the development server with hot reload:
+
+```bash
+npm run dev
+```
+
+The server will run on `http://localhost:3000`
+
+### Build
+
+Compile TypeScript to JavaScript:
+
+```bash
+npm run build
+```
+
+### Production
+
+Build and run in production:
+
+```bash
+npm run build
+npm start
+```
+
+## Project Structure
+
+```
+src/
+├── index.ts              # Entry point
+├── app.ts                # Express app setup
+├── admin/                # Admin model registration
+│   └── model.register.ts
+├── controllers/          # Route controllers
+│   ├── admin/
+│   └── user/
+├── db/                   # Database setup
+│   └── index.ts
+├── interface/            # TypeScript interfaces
+│   └── admin.interface.ts
+├── middlewares/          # Custom middlewares
+├── models/               # Mongoose models
+│   └── admin.models.ts
+├── routers/              # API routes
+└── utils/                # Helper functions
+    ├── apiResponse.ts    # Response formatting
+    ├── asyncHandler.ts   # Async error handling
+    ├── login.ts          # Login logic
+    └── sendMail.ts       # Email sending
+```
+
+## Available Scripts
+
+```bash
+npm run dev    # Start development server with hot reload
+npm run build  # Build TypeScript to JavaScript
+npm start      # Run production build
+```
+
+## Key Utilities
+
+### apiResponse - Format consistent API responses
+```typescript
+import { returnResponse } from "./utils/apiResponse.js";
+returnResponse(res, 200, "Success", { data: "your data" });
+```
+
+### asyncHandler - Wrap async route handlers
+```typescript
+import { asyncHandler } from "./utils/asyncHandler.js";
+router.get("/", asyncHandler(async (req, res) => {
+  // Your async code
+}));
+```
+
+### login - Authenticate users
+```typescript
+import { login } from "./utils/login.js";
+const token = await login("Admin", { email }, password);
+```
+
+### sendMail - Send emails
+```typescript
+import { sendMail } from "./utils/sendMail.js";
+await sendMail({
+  to: "user@example.com",
+  subject: "Welcome",
+  html: "<h1>Welcome!</h1>"
+});
+```
+
+## Environment Variables
+
+```env
+PORT=3000
+MONGODB_URI=mongodb://localhost:27017/app-name
+JWT_SECRET=your-secret-key
+CORS_ORIGIN=http://localhost:3000
+
+SMTP_HOST=smtp.gmail.com
+SMTP_PORT=587
+SMTP_USER=your-email@gmail.com
+SMTP_PASS=your-app-password
+SMTP_FROM=noreply@example.com
+```
+
+## License
+
+ISC
+
+---
+
+Created with [create-nodets-app](https://github.com/krish112407/create-nodets-app)

package/templates/nodejs-typescript/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "my-nodejs-app",
+  "version": "1.0.0",
+  "description": "A Node.js + Express + MongoDB + TypeScript application",
+  "license": "ISC",
+  "author": "Your Name",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "dev": "nodemon --exec tsx src/index.ts",
+    "build": "tsc -p tsconfig.build.json",
+    "start": "node dist/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "nodemon": "^3.1.11",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@types/bcrypt": "^6.0.0",
+    "@types/cookie-parser": "^1.4.10",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.6",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/mongoose": "^5.11.96",
+    "@types/nodemailer": "^7.0.9",
+    "bcrypt": "^6.0.0",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.6",
+    "dotenv": "^17.3.1",
+    "express": "^5.2.1",
+    "jsonwebtoken": "^9.0.3",
+    "mongoose": "^9.1.5",
+    "nodemailer": "^7.0.13"
+  }
+}

package/templates/nodejs-typescript/public/.gitkeep

@@ -0,0 +1,3 @@
+# Public Assets
+
+Store static files here (CSS, images, etc.)

package/templates/nodejs-typescript/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules"]
+}

package/templates/nodejs-typescript/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": false,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}