How phunguyen-byte/roncoo-education works
Major components
• Frontend Clients: Although not directly present in the file tree, the README mentions two separate front-end systems – a public portal (roncoo-education-web) and an admin interface (roncoo-education-admin).
• API Gateway: The “roncoo-education-gateway” module is clearly the entry point. It handles routing, security, and global error handling.
• Microservices:
– Service modules under “roncoo-education-service” which include, for example, a course service (roncoo-education-service-course), a system service, and a user service. Each service is built as a separate microservice.
– “roncoo-education-feign” defines Feign clients to allow inter-service communication. There are separate feign modules for course, system, and user.
• Common Libraries: The “roncoo-education-common” module encapsulates shared utilities, base classes, core tools, and common configurations.
• Development Tools: The “roncoo-generator” module is used for code generation, scaffolding repetitive code such as controllers, service interfaces, and DAOs.
• Deployment and Configuration: The “distribution” folder, Dockerfiles, and docker-compose.yml indicate that containerization and orchestration (via Docker Compose) are used. There is also mention of Nacos (in the code, e.g. “NacosConfig.java”) for service discovery and configuration management.
Relationships and interconnections
• Users (both end users and admin users) interact with frontend clients.
• The frontend clients send requests to the API Gateway (roncoo-education-gateway).
• The Gateway forwards calls to backend microservices – each service (course, system, user) runs independently.
• Inter-service communication is managed via Feign clients (as defined in the “roncoo-education-feign” modules).
• The “common” module is used by several backend services to share libraries, error handling, DTOs (data transfer objects), tools, etc.
• Centralized configuration and service discovery are likely managed by Nacos.
• Distributed transactions are orchestrated via Seata and possibly a service registry.
• Persistent storage is provided by MySQL (as mentioned in the README) using MyBatis and Druid DataSource.
• The code generator is a utility tool used during development to scaffold new modules according to the project’s conventions.
Architectural patterns and design principles
• Microservices Architecture: Each service is isolated (course, system, user), enabling independent development and scaling.
• API Gateway Pattern: The gateway module secures and routes requests effectively.
• Frontend/Backend Separation: Clear boundaries between the presentation layer (Vue/Nuxt3) and the service layer (Spring Cloud-Alibaba).
• Shared Services and Libraries: The “common” module ensures consistency across services.
• Containerization: Docker and docker-compose are used for deployment and orchestration.
• Inter-service Communication: Feign clients and RESTful APIs manage communication between microservices.
• Distributed Configuration and Transaction Management: Nacos for centralized configuration and Seata for managing distributed transactions.