Isam NestJS Starter CLI

🚀 A powerful CLI tool to generate production-ready NestJS applications with authentication, database integration, email service, and complete module generation.

✨ Features

• 🔐 JWT Authentication - Complete auth system with email verification
• 📧 Email Service - SMTP integration with HTML templates
• 🗄️ Multi-Database Support - PostgreSQL, MySQL, SQLite, MongoDB
• 🏗️ Module Generator - Generate complete CRUD modules instantly
• 🔒 Security First - Built-in guards, permissions, and validation
• 📚 TypeScript - Full TypeScript support with strict mode
• 🐳 Docker Ready - Includes Dockerfile and docker-compose
• 📖 Comprehensive Docs - Detailed documentation and examples

🚀 Quick Start

Installation

npm install -g isam-nestjs-starter-cli

Create Your First Project

# Create project with authentication and email
isam-nestjs-starter create my-app --auth --database postgres --email

# Navigate to project
cd my-app

# Install dependencies
npm install

# Start development server
npm run start:dev

Generate Modules

# Generate a complete CRUD module
isam-nestjs-starter generate module products

📋 Commands

Create Project

isam-nestjs-starter create <project-name> [options]

Options:

• --auth - Include authentication module
• --database <type> - Database type (postgres, mysql, sqlite, mongodb)
• --email - Include email service
• --upload - Include file upload module

Examples:

# Full-featured project
isam-nestjs-starter create ecommerce-api --auth --database postgres --email --upload

# Minimal project
isam-nestjs-starter create simple-api --database sqlite

# Interactive mode (prompts for options)
isam-nestjs-starter create my-project

Generate Module

isam-nestjs-starter generate module <module-name>

Generates:

• Controller with CRUD endpoints
• Service with business logic
• Entity with TypeORM decorators
• Repository for database operations
• DTOs with validation
• Permissions for access control
• Audit middleware

🏗️ Generated Project Structure

my-app/
├── src/
│   ├── common/           # Shared utilities and decorators
│   ├── config/           # Configuration files
│   ├── modules/
│   │   ├── auth/         # Authentication module
│   │   ├── email/        # Email service
│   │   └── users/        # User management
│   ├── app.module.ts
│   └── main.ts
├── .env.example
├── docker-compose.yml
├── Dockerfile
└── package.json

🔐 Authentication Features

• User Registration with email verification
• JWT Token authentication
• Password Reset via email
• Email Verification system
• Role-based access control
• Permissions system

API Endpoints

POST /auth/register      # User registration
POST /auth/login         # User login
POST /auth/verify-email  # Email verification
POST /auth/forgot-password # Password reset request
POST /auth/reset-password  # Password reset

📧 Email Service

Built-in email service with:

• SMTP Configuration for multiple providers
• HTML Templates with variable substitution
• Email Verification templates
• Password Reset templates
• Welcome Email templates

Configuration

SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
[email protected]
SMTP_PASS=your-app-password
[email protected]

🗄️ Database Support

Supported Databases

• PostgreSQL (recommended)
• MySQL
• SQLite (for development)
• MongoDB

Configuration Example

DB_TYPE=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=your_username
DB_PASSWORD=your_password
DB_DATABASE=your_database

🏗️ Module Generation

Generate complete modules with a single command:

isam-nestjs-starter generate module products

Creates:

src/modules/products/
├── controllers/products.controller.ts    # CRUD endpoints
├── services/products.service.ts          # Business logic
├── entities/product.entity.ts            # Database entity
├── repositories/products.repository.ts   # Data access
├── dto/                                  # Data transfer objects
├── permissions/products.permissions.ts   # Access control
└── middlewares/products-audit.middleware.ts # Logging

🔒 Security Features

• JWT Authentication with configurable expiration
• Password Hashing with bcrypt
• Input Validation with class-validator
• CORS Configuration
• Rate Limiting ready
• Security Headers with Helmet
• SQL Injection protection via TypeORM

🐳 Docker Support

Generated projects include:

Dockerfile:

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["npm", "run", "start:prod"]

docker-compose.yml:

version: '3.8'
services:
  app:
    build: .
    ports:
      - "3000:3000"
  postgres:
    image: postgres:15
    environment:
      POSTGRES_DB: myapp

📚 Documentation

Comprehensive documentation is available at:

📖 Full Documentation

Or browse individual sections:

• Installation Guide
• Quick Start
• Authentication Guide
• Database Configuration
• Email Service
• Module Generation
• Security Best Practices
• Deployment Guide

🚀 Deployment

Production Build

npm run build
npm run start:prod

Docker Deployment

docker build -t my-app .
docker run -p 3000:3000 my-app

Cloud Deployment

Supports deployment to:

• AWS Elastic Beanstalk
• Heroku
• DigitalOcean App Platform
• Google Cloud Run

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

git clone https://github.com/isamch/nestjs-starter-cli.git
cd nestjs-starter-cli
npm install
npm link

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• 📖 Documentation: https://nestjs-cli-doc.isamchajia.com
• 🐛 Issues: GitHub Issues
• ❓ FAQ: Frequently Asked Questions
• 🔧 Troubleshooting: Common Issues

🎯 Examples

E-commerce API

isam-nestjs-starter create ecommerce-api --auth --database postgres --email
cd ecommerce-api
isam-nestjs-starter generate module products
isam-nestjs-starter generate module orders
isam-nestjs-starter generate module categories

Blog API

isam-nestjs-starter create blog-api --auth --database postgres --email
cd blog-api
isam-nestjs-starter generate module posts
isam-nestjs-starter generate module comments

Simple CRUD API

isam-nestjs-starter create simple-api --database sqlite
cd simple-api
isam-nestjs-starter generate module tasks

Made with ❤️ by Isam Chajia

Generate production-ready NestJS applications in seconds!