# mosip/admin-ui architecture

> Architecture diagram of the GitHub repository mosip/admin-ui, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mosip/admin-ui
- Repository: https://github.com/mosip/admin-ui

## Overview

##### Project type and purpose
- This repository contains two main deliverables:
- admin-ui: An Angular 8 single-page application (SPA) that serves as the MOSIP Admin Portal front end.
- admintest: A Java/Maven TestNG-based automation framework that exercises the portal and its backend APIs.

##### File structure
- Top-level directories:
- .github: CI/CD workflows (push, release, tagging).
- admin-ui: Angular CLI application with Dockerfile, Nginx configs, core/feature/shared modules, assets, environments.
- admintest: Java test harness (pom.xml, source under src/main/java, resources, TestNG files).
- Patterns:
- admin-ui uses a modular Angular architecture (Core module, Feature modules, Shared components).
- Nginx is employed as a reverse proxy and static file host (Docker).
- admintest uses RestClient, DBManager, KeycloakUserManager, S3Adapter, TestRunner to drive end-to-end tests.

##### README
- Confirms admin-ui is served via `ng serve` (dev) or built into `dist/` for Docker deployment.
- No backend source here: the portal relies on MOSIP REST microservices and Keycloak for authentication.

##### Elements
- Green for gateway/proxy
- Orange for backend microservices

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client Layer" 
        direction TB
        Browser["Browser"]:::frontend
        CoreModule["Core Module"]:::frontend
        HTTPInterceptor["HTTPInterceptor"]:::frontend
        SharedModule["Shared Module"]:::frontend
        subgraph "Feature Modules"
            direction TB
            BulkUploadFeature["Bulk Upload Feature"]:::frontend
            KeyManagerFeature["Key Manager Feature"]:::frontend
            LostRIDFeature["Lost RID Status Feature"]:::frontend
            MasterDataFeature["Master Data Feature"]:::frontend
            PacketStatusFeature["Packet Status Feature"]:::frontend
            RIDStatusFeature["RID Status Feature"]:::frontend
            ResourcesFeature["Resources Feature"]:::frontend
        end
    end

    %% Gateway Layer
    subgraph "Gateway Layer"
        direction TB
        Nginx["Nginx (Docker)"]:::gateway
        Dockerfile_Nginx["Dockerfile"]:::gateway
        NginxConf["nginx.conf"]:::gateway
        DefaultConf["default.conf"]:::gateway
        ProxyConf["proxy.conf.json"]:::gateway
    end

    %% Auth Layer
    Keycloak["Keycloak (OIDC/OAuth2)"]:::external

    %% Application Layer
    subgraph "Application Layer"
        direction TB
        AuthService["Auth Service"]:::microservice
        MasterDataService["Master Data Service"]:::microservice
        BulkUploadService["Bulk Upload Service"]:::microservice
        KeyManagerServiceMS["Key Manager Service"]:::microservice
        RIDStatusService["RID Status Service"]:::microservice
        PacketStatusService["Packet Status Service"]:::microservice
        AuditService["Audit Service"]:::microservice
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        AuthDB[(Auth DB)]:::db
        MasterDataDB[(Master Data DB)]:::db
        BulkUploadDB[(Bulk Upload DB)]:::db
        KeyManagerDB[(Key Manager DB)]:::db
        RIDStatusDB[(RID Status DB)]:::db
        PacketStatusDB[(Packet Status DB)]:::db
        AuditDB[(Audit DB)]:::db
        S3Storage["S3 Object Storage"]:::external
    end

    %% Test Harness
    subgraph "Test Harness"
        direction TB
        TestRunner["TestRunner"]:::test
        RestClient["RestClient"]:::test
        DBManager["DBManager"]:::test
        KeycloakUserManager["KeycloakUserManager"]:::test
        KernelAuth["KernelAuthentication"]:::test
        S3Adapter["S3Adapter"]:::test
        ApplicationLibrary["ApplicationLibrary"]:::test
    end

    %% Connections
    Browser -->|"loads SPA"| CoreModule
    Browser --> SharedModule
    CoreModule --> HTTPInterceptor
    CoreModule --> SharedModule
    CoreModule --> BulkUploadFeature
    CoreModule --> KeyManagerFeature
    CoreModule --> LostRIDFeature
    CoreModule --> MasterDataFeature
    CoreModule --> PacketStatusFeature
    CoreModule --> RIDStatusFeature
    CoreModule --> ResourcesFeature

    HTTPInterceptor -->|"{JWT}"| Nginx
    Browser -->|"HTTPS OIDC"| Keycloak
    Nginx -->|"/api/auth"| AuthService
    Nginx -->|"/api/masterdata"| MasterDataService
    Nginx -->|"/api/bulkupload"| BulkUploadService
    Nginx -->|"/api/keymanager"| KeyManagerServiceMS
    Nginx -->|"/api/ridstatus"| RIDStatusService
    Nginx -->|"/api/packetstatus"| PacketStatusService
    Nginx -->|"/api/audit"| AuditService

    AuthService -->|JDBC| AuthDB
    MasterDataService -->|JDBC| MasterDataDB
    BulkUploadService -->|JDBC| BulkUploadDB
    KeyManagerServiceMS -->|JDBC| KeyManagerDB
    RIDStatusService -->|JDBC| RIDStatusDB
    PacketStatusService -->|JDBC| PacketStatusDB
    AuditService -->|JDBC| AuditDB

    BulkUploadService -->|"S3 API"| S3Storage
    TestRunner -->|uses| RestClient
    TestRunner -->|uses| DBManager
    TestRunner -->|uses| KeycloakUserManager
    TestRunner -->|uses| KernelAuth
    TestRunner -->|uses| S3Adapter
    TestRunner -->|uses| ApplicationLibrary

    RestClient -->|HTTPS| Nginx
    DBManager -->|JDBC| AuthDB
    DBManager -->|JDBC| MasterDataDB
    DBManager -->|JDBC| BulkUploadDB
    KeycloakUserManager -->|OIDC| Keycloak
    S3Adapter -->|S3 API| S3Storage

    %% Click Events
    click Browser "https://github.com/mosip/admin-ui/tree/master/admin-ui/"
    click CoreModule "https://github.com/mosip/admin-ui/blob/master/admin-ui/src/app/core/core.module.ts"
    click HTTPInterceptor "https://github.com/mosip/admin-ui/blob/master/admin-ui/src/app/core/services/httpinterceptor.ts"
    click SharedModule "https://github.com/mosip/admin-ui/blob/master/admin-ui/src/app/shared/shared.module.ts"
    click BulkUploadFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/bulkupload/"
    click KeyManagerFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/keymanager/"
    click LostRIDFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/lost-rid-status/"
    click MasterDataFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/masterdata/"
    click PacketStatusFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/packet-status/"
    click RIDStatusFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/rid-status/"
    click ResourcesFeature "https://github.com/mosip/admin-ui/tree/master/admin-ui/src/app/features/resources/"
    click Dockerfile_Nginx "https://github.com/mosip/admin-ui/tree/master/admin-ui/Dockerfile"
    click NginxConf "https://github.com/mosip/admin-ui/blob/master/admin-ui/nginx.conf"
    click DefaultConf "https://github.com/mosip/admin-ui/blob/master/admin-ui/default.conf"
    click ProxyConf "https://github.com/mosip/admin-ui/blob/master/admin-ui/proxy.conf.json"
    click TestRunner "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/utility/TestRunner.java"
    click RestClient "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/authentication/fw/util/RestClient.java"
    click DBManager "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/dbaccess/DBManager.java"
    click KeycloakUserManager "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/kernel/util/KeycloakUserManager.java"
    click KernelAuth "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/kernel/util/KernelAuthentication.java"
    click S3Adapter "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/kernel/util/S3Adapter.java"
    click ApplicationLibrary "https://github.com/mosip/admin-ui/blob/master/admintest/src/main/java/io/mosip/testrig/adminui/kernel/service/ApplicationLibrary.java"
    click TestRunner "https://github.com/mosip/admin-ui/blob/master/admintest/pom.xml"
    click TestRunner "https://github.com/mosip/admin-ui/tree/master/admintest/Dockerfile"

    %% Styles
    classDef frontend fill:#D0E6FF,stroke:#0366D6,color:#0366D6;
    classDef gateway fill:#E2F0D9,stroke:#28A745,color:#28A745;
    classDef microservice fill:#FFEFD5,stroke:#FF8C00,color:#FF8C00;
    classDef db fill:#FFF5E6,stroke:#D2691E,color:#D2691E;
    classDef external fill:#F0F0F0,stroke:#6C757D,color:#6C757D;
    classDef test fill:#EFEFEF,stroke:#6F42C1,color:#6F42C1;
```
