# vishnuvinay89/all-saas-user-microservice architecture

> Architecture diagram of the GitHub repository vishnuvinay89/all-saas-user-microservice, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vishnuvinay89/all-saas-user-microservice
- Repository: https://github.com/vishnuvinay89/all-saas-user-microservice

## Overview

##### Project Type and Purpose
- This is a backend monolith built with NestJS (a TypeScript Node.js framework) providing a collection of REST/GraphQL‐style APIs.
- It orchestrates multiple domain modules (attendance, cohort, user, RBAC/privileges, course, fields, etc.), each with its own controllers, services, DTOs, and entity definitions.
- It uses adapter/service‐locator patterns to switch between different data sources (Hasura GraphQL, PostgreSQL, external Diksha API) and integrates Keycloak for authentication/authorization.

##### File Structure
- Top‐level project: Dockerfile, docker-compose.yml, CI/CD (Jenkinsfile, GitHub workflows), manifests for Kubernetes.
- src/ contains:
- app.controller.ts/app.module.ts: Entry point and root DI container
- Domain folders (attendance/, cohort/, user/, rbac/, etc.) each with controller, service, DTOs, entities
- src/adapters/: Adapter abstractions & concrete implementations under hasura/, postgres/, diksha/
- src/common/: Global modules, guards, filters, decorators (Keycloak integration, RBAC guards)
- src/configs, src/courseTracking, src/fields: Additional domain modules
- src/auth & src/authRbac: Authentication and authorization services
- CI/CD configs and Kubernetes manifests reside at root and .github/workflows/.

##### README Insights
- No explicit architecture section, so we infer patterns & external integrations from code.

##### Main Components & Relationships
a. API Layer (Controllers)
- Exposed REST endpoints by controllers in each module (e.g., /attendance, /cohort, /user, /rbac/assign-role, etc.)
b. Service Layer
- Business logic in module services (e.g., AttendanceService, CohortService).
c. Adapter Layer (Ports & Adapters)
- Generic service locators (e.g., AttendanceServiceLocator) inject concrete adapters.
- Adapters talk to:
- Hasura GraphQL API
- PostgreSQL DB
- External Diksha API
d. Data Sources & External Services
- Hasura GraphQL endpoint
- PostgreSQL instance
- Diksha REST API
- Keycloak Identity Provider
e. Infrastructure & CI/CD
- Docker build image
- docker-compose for local dev
- Kubernetes manifests (EKS, GitHub Actions, Jenkins pipelines)

##### Architectural Patterns & Design Principles
- Modular (NestJS modules per domain)
- Dependency Injection & Inversion of Control for testability & adapter substitution
- Ports & Adapters (Hexagonal architecture) separating domain logic from data sources
- Layered architecture: Controller → Service → Adapter → Data Source
- Centralized authentication/authorization via Keycloak guards and strategies

##### Essential Elements to Capture
- Every domain module (attendance, cohort, user, rbac, etc.) as a logical block
- The adapter layer’s ability to route calls to different backends (Hasura vs. Postgres vs. external API)
- Keycloak’s integration point for authentication and RBAC enforcement
- The CI/CD flow: GitHub Actions/Jenkins → Docker image → EKS (manifest/backend.yaml)
- Configuration (environment variables, NestJS ConfigModule) as a shared concern

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Clients
    Clients["External Clients"]:::external

    %% API Layer
    subgraph "API Layer"
        subgraph "Controllers"
            AC["AttendanceController"]:::controller
            CC["CohortController"]:::controller
            CMC["CohortMembersController"]:::controller
            UC["UserController"]:::controller
            UTMC["UserTenantMappingController"]:::controller
            APPC["AssignPrivilegeController"]:::controller
            ARC["AssignRoleController"]:::controller
            PMC["PrivilegeController"]:::controller
            RMC["RoleController"]:::controller
            COC["CourseController"]:::controller
            CTC["CourseTrackingController"]:::controller
            FC["FieldsController"]:::controller
            CFGC["ConfigController"]:::controller
            AuthC["AuthController"]:::controller
            AuthRbacC["AuthRbacController"]:::controller
        end
    end

    %% Service Layer
    subgraph "Service Layer"
        AS["AttendanceService"]:::service
        CS["CohortService"]:::service
        CMS["CohortMembersService"]:::service
        US["UserService"]:::service
        UTMS["UserTenantMappingService"]:::service
        APS["AssignPrivilegeService"]:::service
        ARS["AssignRoleService"]:::service
        PMS["PrivilegeService"]:::service
        RMS["RoleService"]:::service
        COS["CourseService"]:::service
        CTS["CourseTrackingService"]:::service
        FS["FieldsService"]:::service
        CFGS["ConfigService"]:::service
        AuthS["AuthService"]:::service
        AuthRbacS["AuthRbacService"]:::service
    end

    %% Adapter Layer
    subgraph "Adapter Layer"
        HA["HasuraAdapter"]:::adapter
        PA["PostgresAdapter"]:::adapter
        DA["DikshaAdapter"]:::adapter
    end

    %% Data Sources
    subgraph "Data Sources"
        HasuraDB["Hasura GraphQL"]:::db
        PostgresDB["PostgreSQL"]:::db
        DikshaAPI["Diksha REST API"]:::external
        Keycloak["Keycloak"]:::external
    end

    %% CI/CD & Deployment
    subgraph "CI/CD & Deployment"
        Repo["Code Repository"]:::infra
        CI["GitHub Actions / Jenkins"]:::infra
        Image["Docker Image"]:::infra
        Cluster["Kubernetes (EKS)"]:::infra
    end

    %% Connections
    Clients -->|"HTTP/REST, GraphQL"| AC
    Clients --> CC
    Clients --> CMC
    Clients --> UC
    Clients --> UTMC
    Clients --> APPC
    Clients --> ARC
    Clients --> PMC
    Clients --> RMC
    Clients --> COC
    Clients --> CTC
    Clients --> FC
    Clients --> CFGC
    Clients --> AuthC
    Clients --> AuthRbacC

    AC -->|uses| AS
    CC -->|uses| CS
    CMC -->|uses| CMS
    UC -->|uses| US
    UTMC -->|uses| UTMS
    APPC -->|uses| APS
    ARC -->|uses| ARS
    PMC -->|uses| PMS
    RMC -->|uses| RMS
    COC -->|uses| COS
    CTC -->|uses| CTS
    FC -->|uses| FS
    CFGC -->|uses| CFGS
    AuthC -->|uses| AuthS
    AuthRbacC -->|uses| AuthRbacS

    AS -->|via locator| HA
    CS -->|via locator| HA
    CMS -->|via locator| HA
    US -->|via locator| PA
    UTMS -->|via locator| PA
    APS -->|via locator| PA
    ARS -->|via locator| PA
    PMS -->|via locator| PA
    RMS -->|via locator| PA
    COS -->|via locator| HA
    CTS -->|via locator| HA
    FS -->|via locator| HA
    CFGS -->|via locator| PA
    AuthS -->|via locator| PA
    AuthRbacS -->|via locator| PA

    HA -->|GraphQL| HasuraDB
    PA -->|TCP/PG| PostgresDB
    DA -->|HTTP/REST| DikshaAPI

    AuthC -->|OAuth2| Keycloak
    AuthRbacC -->|OAuth2| Keycloak

    Repo --> CI --> Image --> Cluster

    %% Click Events
    click AC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/attendance/attendance.controller.ts"
    click AS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/attendance/attendance.module.ts"
    click CC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/cohort/cohort.controller.ts"
    click CS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/cohort/cohort.service.ts"
    click CMC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/cohortMembers/cohortMembers.controller.ts"
    click CMS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/cohortMembers/cohortMembers.module.ts"
    click UC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/user/user.controller.ts"
    click US "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/user/user.module.ts"
    click UTMC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/userTenantMapping/user-tenant-mapping.controller.ts"
    click UTMS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/userTenantMapping/user-tenant-mapping.module.ts"
    click APPC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/assign-privilege/assign-privilege.controller.ts"
    click APS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/assign-privilege/assign-privilege.module.ts"
    click ARC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/assign-role/assign-role.controller.ts"
    click ARS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/assign-role/assign-role.module.ts"
    click PMC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/privilege/privilege.controller.ts"
    click PMS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/privilege/privilege.module.ts"
    click RMC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/role/role.controller.ts"
    click RMS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/rbac/role/role.module.ts"
    click COC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/course/course.controller.ts"
    click COS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/course/course.module.ts"
    click CTC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/courseTracking/courseTracking.controller.ts"
    click CTS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/courseTracking/courseTracking.module.ts"
    click FC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/fields/fields.controller.ts"
    click FS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/fields/fields.service.ts"
    click CFGC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/configs/config.controller.ts"
    click CFGS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/configs/configuration.module.ts"
    click AuthC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/auth/auth.controller.ts"
    click AuthS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/auth/auth.service.ts"
    click AuthRbacC "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/authRbac/authRbac.controller.ts"
    click AuthRbacS "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/authRbac/authRbac.service.ts"
    click HA "https://github.com/vishnuvinay89/all-saas-user-microservice/tree/main/src/adapters/hasura"
    click PA "https://github.com/vishnuvinay89/all-saas-user-microservice/tree/main/src/adapters/postgres"
    click DA "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/src/adapters/diksha/dikshaCourse.adapter.ts"
    click Repo "https://github.com/vishnuvinay89/all-saas-user-microservice/tree/main/Jenkinsfile"
    click CI "https://github.com/vishnuvinay89/all-saas-user-microservice/tree/main/.github/workflows"
    click Image "https://github.com/vishnuvinay89/all-saas-user-microservice/tree/main/Dockerfile"
    click Cluster "https://github.com/vishnuvinay89/all-saas-user-microservice/blob/main/manifest/backend.yaml"

    %% Styles
    classDef controller fill:#f9f,stroke:#333,stroke-width:1px
    classDef service fill:#9ff,stroke:#333,stroke-width:1px
    classDef adapter fill:#ff9,stroke:#333,stroke-width:1px
    classDef db fill:#ffb,stroke:#333,stroke-width:1px
    classDef external fill:#bff,stroke:#333,stroke-width:1px
    classDef infra fill:#cfc,stroke:#333,stroke-width:1px
```
