-
Notifications
You must be signed in to change notification settings - Fork 23
Open
Description
Description
Currently, the MicroForge architecture is well-documented via tables and text, but it lacks a visual representation of how the services interact. Since this project showcases a complex polyglot microservices ecosystem, adding Mermaid.js diagrams will significantly improve the "at-a-glance" understanding for developers and recruiters.
Proposed Scope
I suggest adding the following diagrams to the main README.md:
- System Architecture Diagram: A high-level Flowchart showing the Request flow from the Frontend through Nginx/Ingress to the specific microservices (Go, Java, Python, Node).
- Service Interaction & Database Map: A diagram showing which services own which MySQL databases (Database-per-service pattern).
- Authentication Sequence: A sequence diagram showing the JWT handshake between the Login Service, Auth Service, and Frontend.
Implementation Plan
- Location: Under a new
## 🏗️ System Architecturesection. - Technology: Use GitHub’s native Mermaid support (no external images required).
- Format:
```mermaid
graph TD
User((User)) --> FE[Frontend - React]
FE --> Auth[Auth Service - Go]
FE --> Login[Login Service - Java]
Login --> LDB[(Login DB)]
Why this matters?
- Visual Clarity: Instantly explains the polyglot nature of the project.
- Maintainability: Being code-based, diagrams can be updated via PRs as the architecture evolves (unlike static
.pngfiles). - Professionalism: Aligns with enterprise-grade documentation standards.
I would love to work on the issue and Submit a PR.
Labels: SWOC, SWOC'26
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Projects
Status
Backlog