Skip to content

Integrate Mermaid.js Architecture Diagrams in README #61

@Nitya-003

Description

@Nitya-003

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:

  1. 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).
  2. Service Interaction & Database Map: A diagram showing which services own which MySQL databases (Database-per-service pattern).
  3. Authentication Sequence: A sequence diagram showing the JWT handshake between the Login Service, Auth Service, and Frontend.

Implementation Plan

  • Location: Under a new ## 🏗️ System Architecture section.
  • 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?

  1. Visual Clarity: Instantly explains the polyglot nature of the project.
  2. Maintainability: Being code-based, diagrams can be updated via PRs as the architecture evolves (unlike static .png files).
  3. Professionalism: Aligns with enterprise-grade documentation standards.

I would love to work on the issue and Submit a PR.

Labels: SWOC, SWOC'26

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions