Skip to content

Home

Jump to bottom
Harmeet Singh edited this page Jul 25, 2025 · 1 revision

🔐 Production-Grade Authentication Template

Welcome to the official wiki for the Production-Grade Authentication Template!
This project provides a robust, secure, and scalable foundation for authentication services built with Node.js, Express, MongoDB, and Redis.

🚀 Overview

This template is designed for teams and individuals who want a ready-to-use backend authentication solution with best practices for security, scalability, and developer experience.

Core Technologies:

  • Node.js (22.14.0+)
  • Express
  • MongoDB (via Mongoose)
  • Redis (via ioredis)
  • Docker (for containerization)
  • TypeScript types
  • Joi (validation)
  • Winston (logging)
  • Swagger (API docs)

✨ Key Features

  • Complete Authentication System
    User registration, email verification, JWT-based login, password reset, refresh token rotation, session management with Redis.

  • Security First Approach
    CORS, Helmet, rate limiting, MongoDB sanitization, XSS protection, secure HTTP-only cookies, Joi validation, content security policies.

  • Production Ready
    Dockerized deployment (dev/prod), Webpack bundling, environment configs, structured logging, health checks, database backup to S3, RabbitMQ integration.

  • Developer Experience
    Hot reloading, linting/formatting (ESLint, Prettier), git hooks (Husky), comprehensive tests, conventional commit messages, clear project structure.

📦 Project Structure

🗂️ Folder Organization 
backend/
├── docker/                # Docker configuration files
│   ├── dev/               # Development Docker setup
│   └── prod/              # Production Docker setup
├── docs/                  # API documentation
│   ├── swagger-output.json
│   └── swagger.js
├── logs/                  # Application logs
├── nginx/                 # Nginx configuration for deployment
│   ├── http.conf
│   └── https.conf
├── scripts/               # Utility scripts
│   ├── cron.sh
│   ├── dbBackup.js
│   └── docker.sh
├── src/                   # Source code
│   ├── config/            # Configuration files
│   ├── constant/          # Constants and enums
│   ├── controllers/       # Request handlers
│   ├── db/                # Database connection modules
│   ├── helpers/           # Helper utilities
│   ├── middlewares/       # Express middlewares
│   ├── models/            # Mongoose models
│   ├── repository/        # Data access layer
│   ├── routes/            # API routes
│   ├── services/          # Business logic layer
│   ├── types/             # TypeScript type definitions
│   ├── utils/             # Utility functions
│   ├── validations/       # Input validation schemas
│   ├── app.js             # Express application setup
│   └── index.js           # Application entry point
└── test/                  # Test files
    ├── mockData/          # Mock data for tests
    ├── routes/            # API route tests
    ├── utils/             # Test utilities
    └── validations/       # Validation tests

🛡️ Security Highlights

  • JWT authentication with refresh token rotation
  • Password hashing (bcrypt)
  • Rate limiting
  • Robust input validation (Joi)
  • HTTP security headers (Helmet)
  • Secure cookies
  • Protection against NoSQL injection and XSS

🗒️ Getting Started

Prerequisites:

  • Node.js ≥ 22.14.0
  • npm ≥ 10.7.0
  • MongoDB (latest)
  • Redis (latest)
  • Docker (optional for deployment)

Installation:

git clone https://github.com/Harmeet10000/ts-backend-production-template.git
cd ts-backend-production-template
npm install

Create a `.env.dev` file in the root directory with the following variables:

```env
# Server
NODE_ENV=development
PORT=3000
SERVER_URL=http://localhost:3000

# Database
DATABASE_URL=mongodb://localhost:27017/auth-service
REDIS_URL=redis://localhost:6379

# JWT
ACCESS_TOKEN_SECRET=your_access_token_secret
REFRESH_TOKEN_SECRET=your_refresh_token_secret
ACCESS_TOKEN_EXPIRY=900
REFRESH_TOKEN_EXPIRY=604800

# Email
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
EMAIL_USER=your_email@example.com
EMAIL_PASSWORD=your_email_password
EMAIL_FROM=noreply@yourservice.com

# Frontend
FRONTEND_URL=http://localhost:5173

# Backup Configuration
S3_BACKUP_ENABLED=true
S3_BUCKET_NAME=your-backup-bucket
AWS_REGION=us-east-1
S3_PREFIX=mongodb-backups/

🛠️ Available Scripts

📋 NPM Commands
Command Description
npm run dev Start the development server with hot reload
npm run build Build the production bundle
npm run dev:prod Run production build with nodemon
npm start Start the production server
npm run swagger Generate Swagger documentation
npm test Run the test suite
npm run test:watch Run tests in watch mode
npm run test:coverage Run tests with coverage report
npm run lint Check code for linting errors
npm run lint:fix Fix linting errors automatically
npm run format Check code formatting
npm run format:fix Fix formatting issues automatically
npm run migrate:dev Run database migrations in development
npm run migrate:prod Run database migrations in production

🧪 Testing

🧠 Test Commands

Run all tests:

npm test

Run tests in watch mode:

npm run test:watch

Generate test coverage report:

npm run test:coverage

🤝 Contributing

📜 Contribution Guidelines
  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

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

⭐ Star this repository if you find it useful! ⭐

Created with ❤️ by Harmeet Singh

⬆️ Back to top ⬆️

Clone this wiki locally