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

npm create nodets-app-nish

Or with a project name:

npm create nodets-app-nish my-app

Usage

Interactive Mode

npm create nodets-app-nish

You'll be prompted to enter your project name.

With Project Name

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

cd my-app
npm install
cp .env.example .env
# Edit .env with your configuration
npm run dev

Available Scripts

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:

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
[email protected]
SMTP_PASS=your-app-password
[email protected]

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
2. Login locally: npm login
3. Publish: npm publish

After publishing, users can use your template:

npx create-nodets-app my-project

License

ISC

Author

krish112407

Made with ❤️ for Node.js developers | Based on professional backend architecture