Mezon Eatery Bot

A modern, scalable chat bot built with NestJS and TypeScript for the Mezon chat platform.

🚀 Features

• Modern Architecture: Built with NestJS framework using TypeScript
• Command System: Extensible command system with metadata support
• Event-Driven: Event-driven architecture with proper separation of concerns
• Database Integration: PostgreSQL with TypeORM for data persistence
• Message Queue: Efficient message processing with throttling
• Error Handling: Comprehensive error handling and logging
• Modular Design: Clean, maintainable, and testable code structure

📋 Prerequisites

• Node.js 18+
• PostgreSQL 12+
• yarn (recommended) or npm

🔧 Installation

1. Clone the repository

   git clone https://github.com/hoangduy0610/mezon-bot-template.git
   cd mezon-bot-template

2. Install dependencies

   yarn

3. Environment Setup

   cp .env.example .env.local

   Configure your environment variables:

   POSTGRES_HOST=localhost
   POSTGRES_PORT=5432
   POSTGRES_USER=postgres
   POSTGRES_PASSWORD=your_password
   POSTGRES_DB=mezon_bot
   MEZON_TOKEN=your_mezon_bot_token

4. Database Setup

   # Run migrations
   yarn db:run

🚀 Running the Application

# Development mode
yarn start:dev

# Production mode
yarn start:prod

# Debug mode
yarn start:debug

🤖 Available Commands

Command	Description	Usage
!help	Show available commands	!help [command]
!ping	Check bot latency	!ping
!about	Bot information	!about

🏗️ Project Structure

src/
├── command/           # Bot commands
│   ├── common/       # Command abstractions
│   ├── help.command.ts
│   ├── ping.command.ts
│   └── about.command.ts
├── common/           # Shared constants and utilities
├── config/           # Configuration files
├── decorators/       # Custom decorators
├── dtos/            # Data transfer objects
├── entities/        # Database entities
├── gateway/         # Event gateways
├── listeners/       # Event listeners
├── modules/         # NestJS modules
├── services/        # Business logic services
├── types/           # TypeScript type definitions
└── utils/           # Utility functions

🧪 Testing

# Unit tests
yarn test

# End-to-end tests
yarn test:e2e

# Test coverage
yarn test:cov

📊 Database

The bot uses PostgreSQL with TypeORM for data persistence. Key entities:

🔧 Development

Adding New Commands

1. Create a new command file in src/command/
2. Extend CommandMessage class
3. Use @Command decorator with metadata
4. Register in BotModule

Example:

@Command('example', {
    description: 'An example command',
    usage: '!example [args]',
    category: 'Utility',
})
export class ExampleCommand extends CommandMessage {
    execute(args: string[], message: ChannelMessage) {
        return this.replyMessageGenerate({ 
            messageContent: 'Hello World!' 
        }, message);
    }
}

Code Quality

# Lint code
yarn lint

# Format code
yarn format

📚 Architecture

Core Components

• BotGateway: Handles Mezon SDK events
• MessageCommand: Processes message queue with throttling
• CommandService: Routes commands to handlers
• MessageQueue: Manages message processing queue

Design Patterns

• Command Pattern: For bot commands
• Observer Pattern: For event handling
• Dependency Injection: Via NestJS
• Repository Pattern: With TypeORM

🚀 Deployment

Docker (Recommended)

# Build image
docker build -t mezon-bot-template .

# Run container
docker run -d --name mezon-bot-template \
  --env-file .env.production \
  -p 3000:3000 \
  mezon-template

Manual Deployment

# Build application
yarn build

# Run production
NODE_ENV=production yarn start:prod

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

📄 License

This project is licensed under the ISC License.

👤 Author

Nguyen Hoang Duy

• GitHub: @hoangduy0610

🙏 Acknowledgments

• Built with NestJS
• Powered by Mezon SDK
• Database with TypeORM