Merge pull request #54 from nashtech-garage/feature/analyze-microservices

feature analyze and design system architecture for microservice

Author: nguyenvanhadncntt

MICROSERVICES_ARCHITECTURE.md

@@ -0,0 +1,198 @@
+# Smart TaskHub - Project Management System
+
+## 📋 Overview
+
+Smart TaskHub is a Trello-like project management platform built with a modern microservices architecture. It provides teams with powerful tools to organize projects, manage tasks, collaborate effectively, and track progress in an intuitive and scalable environment.
+
+## 🏗️ Architecture
+
+![Smart TaskHub Microservices Architecture](backend/smart_taskhub_microservices.png)
+
+The system follows a microservices architecture pattern with the following key components:
+
+- **Frontend**: React Web Application
+- **API Gateway**: Kong Gateway for routing and load balancing
+- **Authentication**: Keycloak for identity and access management
+- **Business Services**: Multiple Play Framework-based microservices
+- **Database**: PostgreSQL for data persistence
+- **Caching**: Redis for performance optimization
+- **External Services**: Mailtrap for email delivery, Cloudinary for file storage
+
+## 🚀 Core Services
+
+### 1. **Identity Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**: 
+  - User registration and authentication
+  - User profile management
+  - Integration with Keycloak for SSO
+  - Role and permission management
+
+### 2. **Project Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Project creation and management
+  - Project settings and configuration
+  - Team member assignment
+  - Project visibility and access control
+
+### 3. **Workspace Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Workspace creation and management
+  - Board organization within workspaces
+  - Workspace-level permissions
+  - Team collaboration spaces
+
+### 4. **Task Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Task creation, updating, and deletion
+  - Task assignment and status tracking
+  - Due dates and priority management
+  - Task dependencies and relationships
+  - Card movement between lists/columns
+
+### 5. **Comment Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Task and project commenting system
+  - Comment threading and replies
+  - Mention notifications
+  - Activity feed generation
+
+### 6. **Notification Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Real-time notifications
+  - Email notification triggers
+  - Push notification management
+  - Notification preferences
+
+### 7. **WebSocket Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Real-time collaboration features
+  - Live updates for task changes
+  - User presence indicators
+  - Instant messaging capabilities
+
+### 8. **Mail Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - Email template management
+  - Email sending orchestration
+  - Integration with Mailtrap service
+  - Email delivery tracking
+
+### 9. **Media Service**
+- **Technology**: Play Framework (Scala/Java)
+- **Function**:
+  - File upload and management
+  - Image processing and optimization
+  - Integration with Cloudinary
+  - Attachment handling for tasks and comments
+
+## 🛠️ Technology Stack
+
+### **Frontend**
+- **React**: Modern JavaScript library for building user interfaces
+- **Features**: Responsive design, real-time updates, drag-and-drop functionality
+
+### **Backend Services**
+- **Play Framework**: High-performance web framework for Java and Scala
+- **Benefits**: Reactive programming, built-in testing, RESTful APIs
+
+### **API Gateway**
+- **Kong**: Cloud-native API gateway
+- **Features**: Load balancing, rate limiting, authentication, monitoring
+
+### **Authentication & Authorization**
+- **Keycloak**: Open-source identity and access management
+- **Features**: SSO, OAuth 2.0, RBAC, user federation
+
+### **Database**
+- **PostgreSQL**: Advanced open-source relational database
+- **Features**: ACID compliance, JSON support, full-text search
+
+### **Caching**
+- **Redis**: In-memory data structure store
+- **Use Cases**: Session storage, API response caching, real-time data
+
+### **External Services**
+- **Mailtrap**: Email testing and delivery service
+- **Cloudinary**: Cloud-based image and video management platform
+
+## 🔄 System Flow
+
+1. **User Access**: Users access the React frontend application
+2. **API Gateway**: All requests are routed through Kong Gateway
+3. **Authentication**: Keycloak handles user authentication and authorization
+4. **Service Communication**: Microservices communicate via REST APIs
+5. **Data Persistence**: PostgreSQL stores all application data
+6. **Caching**: Redis improves performance with intelligent caching
+7. **Real-time Updates**: WebSocket service enables live collaboration
+8. **External Integration**: Mailtrap and Cloudinary handle specialized functions
+
+## 📁 Project Structure
+
+```
+smart-taskhub/
+├── frontend/                 # React Web Application
+├── api-gateway/             # Kong Gateway Configuration
+├── services/
+│   ├── identity-service/    # User Management
+│   ├── project-service/     # Project Management
+│   ├── workspace-service/   # Workspace Management
+│   ├── task-service/        # Task Management
+│   ├── comment-service/     # Comment System
+│   ├── notification-service/# Notification System
+│   ├── websocket-service/   # Real-time Communication
+│   ├── mail-service/        # Email Management
+│   └── media-service/       # File Management
+├── infrastructure/
+│   ├── database/            # PostgreSQL Configuration
+│   ├── cache/              # Redis Configuration
+│   └── keycloak/           # Authentication Configuration
+└── docs/                   # Documentation
+```
+
+## 🚦 Getting Started
+
+### Prerequisites
+- Docker and Docker Compose
+- Node.js (for frontend development)
+- Java 11+ (for backend services)
+- PostgreSQL
+- Redis
+
+### Quick Start
+1. Clone the repository
+2. Set up environment variables
+3. Start infrastructure services (PostgreSQL, Redis, Keycloak)
+4. Deploy microservices
+5. Launch the frontend application
+6. Configure Kong Gateway routes
+
+## 🔧 Configuration
+
+Each service requires specific configuration for:
+- Database connections
+- Redis cache settings
+- Keycloak authentication
+- External service API keys (Mailtrap, Cloudinary)
+- Service discovery and communication
+
+## 📊 Key Features
+
+- **Kanban Boards**: Visual task management with drag-and-drop
+- **Team Collaboration**: Real-time updates and commenting
+- **File Attachments**: Media upload and management
+- **Email Notifications**: Automated email alerts
+- **User Management**: Role-based access control
+- **Scalable Architecture**: Microservices for independent scaling
+- **Real-time Sync**: Live updates across all connected clients
+
+## 🤝 Contributing
+
+This project follows microservices best practices and welcomes contributions to individual services or the overall architecture.