How nhlamdev/social-blog-backend works
Main System Components
a) Core Application Layer:
• NestJS Application Core
• Configuration Management System
• Authentication System
• Database Layer
• WebSocket Gateway
• Helper Services
b) External Services Integration:
• Social Authentication Providers (Discord, GitHub, Google)
• MinIO Storage Service
• Redis Cache
• Email Service
• Queue System
Module Organization
Create distinct sections for the business modules:
• Member Management
• Content Management (Questions, Answers, Comments)
• Category Management
• Series Management
• Notification System
• Storage Management
• Session Management
• Contact Management
┌─ External Services ─┐ ┌─ Authentication ─┐ ┌─ Storage ─┐
• Google │ │ - JWT │ │ - MinIO │
• GitHub │ │ - Social Auth │ └──────────┘
• Discord │ └─────────────────┘
• ┘
┌─ API Layer ────────────────────────────────┐
• Controllers (REST Endpoints) │
• ┤
• Business Logic (Services) │
• ┤
• Data Access Layer (Repositories) │
• ┘
┌─ Helper Services ─┐ ┌─ WebSocket ─┐
• Logger │ │ Gateway │
• Mail │ └─────────────┘
• Configuration │
• ┘
Important Relationships to Highlight
• Authentication flow from social providers through the auth module to the application
• Database interactions with entities
• WebSocket connections for real-time features
• Caching layer interactions
• Demonstrate file storage flow with MinIO
Specific Implementation Notes
• How the modular structure is implemented using NestJS modules
• Separation of concerns between controllers, services, and entities
• Demonstrate how the helper services are shared across modules
• Configuration system's role in managing environment-specific settings
Remember to include version information and any significant dependencies that affect the architecture (like TypeORM, Redis, etc.).
This will provide a comprehensive view of the system while maintaining clarity and usefulness for both development and documentation purposes.