TypeScript Microservice Boilerplate

A production-ready microservice boilerplate with TypeScript, Express, MongoDB, Redis, and OAuth2 authentication.

How to use it

Type the command given below in console

bun create https://github.com/techsouvik/typescript-boiler-plate

Directory Structure

.
├── src/
│   ├── config/           # Configuration files
│   │   ├── index.ts     # Main config
│   │   └── oauth.ts     # OAuth config
│   ├── containers/       # Service containers
│   │   └── ServiceContainer.ts
│   ├── controllers/      # Request handlers
│   │   ├── auth.ts
│   │   └── user.ts
│   ├── interfaces/       # TypeScript interfaces
│   │   └── index.ts
│   ├── middleware/       # Express middleware
│   │   ├── auth.ts
│   │   └── error.ts
│   ├── models/          # Database models
│   │   └── User.ts
│   ├── routes/          # API routes
│   │   ├── auth.ts
│   │   └── user.ts
│   ├── services/        # Business logic
│   │   ├── AuthService.ts
│   │   ├── CacheService.ts
│   │   └── EmailService.ts
│   └── utils/           # Utility functions
│       ├── logger.ts
│       └── cache.ts
├── logs/                # Application logs
│   ├── info.log
│   ├── warn.log
│   ├── error.log
│   └── fatal.log
├── docker/             # Docker configurations
│   ├── api/
│   ├── mongodb/
│   └── redis/
└── tests/              # Test files
    ├── unit/
    └── integration/

## System Design

```mermaid
graph TD
    Client[Client] --> LB[Load Balancer]
    LB --> API1[API Instance 1]
    LB --> API2[API Instance 2]
    LB --> API3[API Instance 3]
    
    API1 --> Auth[OAuth Service]
    API2 --> Auth
    API3 --> Auth
    
    Auth --> Google[Google OAuth]
    Auth --> GitHub[GitHub OAuth]
    
    API1 --> Cache[Redis Cache]
    API2 --> Cache
    API3 --> Cache
    
    API1 --> DB[(MongoDB)]
    API2 --> DB
    API3 --> DB
    
    API1 --> Logger[Logging Service]
    API2 --> Logger
    API3 --> Logger
    
    Logger --> LogFiles[Log Files]
    
    subgraph Monitoring
        Logger
        Metrics[Metrics Collection]
        Alerts[Alert System]
    end

Features

• 🔐 OAuth2 Authentication (Google & GitHub)
• 📊 Advanced Logging System (Info, Warn, Error, Fatal)
• 💾 Redis Caching with LRU
• 📦 MongoDB with Mongoose
• 🚀 Horizontal Scaling
• 📝 Swagger API Documentation
• 🐳 Docker & Docker Compose
• 🔍 Request Tracing
• ⚡ Rate Limiting
• 🛡️ Security Features

Environment Variables

# Server
PORT=3000
NODE_ENV=development

# MongoDB
MONGO_URI=mongodb://localhost:27017/microservice

# Redis
REDIS_URL=redis://localhost:6379

# OAuth
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_REDIRECT_URI=http://localhost:3000/auth/google/callback

GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret
GITHUB_REDIRECT_URI=http://localhost:3000/auth/github/callback

# Email
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
EMAIL_USER=[email protected]
EMAIL_PASS=your-email-password

# Logging
LOG_LEVEL=info
LOG_DIR=./logs