# yudaocode/yudao-ui-admin-vue3 architecture

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

- Interactive diagram: https://gitdiagram.com/yudaocode/yudao-ui-admin-vue3
- Repository: https://github.com/yudaocode/yudao-ui-admin-vue3

## Overview

##### Main Components
- Frontend Application (Client-Side UI): Based on Vue 3 with Vite, using Element Plus for UI components, unocss for styling, and TypeScript for type safety.
- Core Engine & Configuration:
– Entry point (main.ts) that bootstraps the app.
– Routing (vue-router) and state management (pinia) elements.
– Global configuration modules (e.g. axios configuration in src/config/axios and environment variables).
- Modules / Views for Business Domains:
– Large “views” directory containing sub-modules for AI, BPM, CRM, ERP, Mall, member, pay, system, mp, etc.
– Each module (e.g., src/views/system, src/views/ai, src/views/bpm) represents a business domain with its own components and pages.
- UI Components Library:
– A rich set of reusable components (in src/components) for dialogs, tables, charts (echarts), forms, editors, image viewers, and even complex components like form builders and process designers.
- Plugins and Directives:
– Additional functionality such as internationalization (vue-i18n), animations, permission directives, and route guards.
- Build & Configuration Infrastructure:
– Vite and pnpm based build scripts (files in build/ and vite.config.ts) for development and production builds.
– Prettier, ESLint, and style-related configurations ensure code quality.
- Assets & Public Resources:

##### Relationships & Interactions
- The App Initialization (main.ts) starts the application, loads configuration files, sets up plugins (e.g., axios service, vue-i18n), and registers global components.
- The Router (src/router) controls navigation between various business modules. Each module encapsulates its set of pages/views (located in src/views/*) and communicates with state management (src/store) via Pinia.
- API Interaction: Under src/api, many folders implement the API client layer that makes calls to back-end services for modules (e.g., ai, bpm, crm, erp, mall). These act as service definitions and abstractions to the backend, typically using Axios.
- Utility Modules (src/utils, src/hooks) support cross-cutting concerns such as permission management, date formatting, and reactive global events.
- The Build System and Configuration are responsible for bundling the application, optimizing code, and injecting environment-specific parameters during deployment.

##### Architectural Patterns & Technologies
- Component-Based Architecture: The entire application is decomposed into reusable Vue components.
- Module Separation: Each business domain is maintained in its own directory (e.g., src/views/ai, src/views/crm) and has corresponding API definitions, state management modules, and routing configurations.
- Service Oriented Communication: The frontend is designed to interact with separate backend services (Spring Boot or Spring Cloud) which implement business logic.
- Configuration Driven: Environment configuration via various .env files and build scripts signal a flexible, multi-environment deployment setup.
- Design Patterns: Clear separation of concerns (presentational components vs. business logic in store and API modules), usage of hooks for common behaviours, and adherence to MVC-like separation in page designs.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Front-End Dashboard Application"
        %% Core Engine & Configuration
        subgraph "Core Engine & Configuration"
            MA("Entry Point (main.ts)"):::core
            AC("App Component (App.vue)"):::core
            IH("HTML Template (index.html)"):::core
            GC("Global Config (Axios & Env)"):::config
            RM("Routing Module (vue-router)"):::config
            SM("State Management (Pinia)"):::config
        end

        %% UI Components & Layout
        subgraph "UI Components & Layout"
            UIC("UI Components Library"):::ui
            PD("Plugins & Directives"):::plugin
            AS("Assets & Public Resources"):::assets
        end

        %% Business Modules
        subgraph "Business Modules"
            SYS("System Module"):::module
            AI("AI Module"):::module
            BPM("BPM Module"):::module
            CRM("CRM Module"):::module
            ERP("ERP Module"):::module
            MALL("Mall Module"):::module
            MEMBER("Member Module"):::module
            MP("MP Module"):::module
            IOT("IOT Module"):::module
        end

        %% API/Services Layer
        subgraph "API/Services Layer"
            API("API Clients"):::api
        end

        %% Build & Config Infrastructure
        subgraph "Build & Config Infrastructure"
            BS1("Build Scripts"):::build
            BS2("Vite Config"):::build
        end

        %% External Backend
        EB("External Backend"):::external
    end

    %% Connections within Core Engine
    MA --> AC
    AC --> IH
    MA --> GC
    MA --> RM
    MA --> SM
    GC --> RM
    GC --> SM

    %% Connections to Business Modules
    RM --> SYS
    RM --> AI
    RM --> BPM
    RM --> CRM
    RM --> ERP
    RM --> MALL
    RM --> MEMBER
    RM --> MP
    RM --> IOT
    
    UIC --> SYS
    UIC --> AI
    UIC --> BPM
    UIC --> CRM
    UIC --> ERP
    UIC --> MALL
    UIC --> MEMBER
    UIC --> MP
    UIC --> IOT

    PD --> UIC

    %% Business Modules communicating with API layer
    SYS --> API
    AI --> API
    BPM --> API
    CRM --> API
    ERP --> API
    MALL --> API
    MEMBER --> API
    MP --> API
    IOT --> API

    %% API layer calls External Backend
    API --> EB

    %% Build & Config influences Core and Plugins
    BS1 --> MA
    BS1 --> GC
    BS1 --> PD
    BS2 --> MA

    %% Click Events
    click MA "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/main.ts"
    click AC "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/App.vue"
    click IH "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/index.html"
    click GC "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/config/axios"
    click RM "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/router/index.ts"
    click SM "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/store/index.ts"
    click AI "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/ai"
    click BPM "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/bpm"
    click CRM "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/crm"
    click ERP "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/erp"
    click MALL "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/mall"
    click MEMBER "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/member"
    click MP "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/mp"
    click SYS "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/system"
    click IOT "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/iot"
    click UIC "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/components"
    click PD "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/plugins"
    click BS1 "https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/build/vite"
    click BS2 "https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/vite.config.ts"

    %% Styles
    classDef core fill:#f9e79f,stroke:#7d6608,stroke-width:2px;
    classDef config fill:#aed6f1,stroke:#1b4f72,stroke-width:2px;
    classDef ui fill:#abebc6,stroke:#186a3b,stroke-width:2px;
    classDef plugin fill:#f5b7b1,stroke:#943126,stroke-width:2px;
    classDef assets fill:#d2b4de,stroke:#512e5f,stroke-width:2px;
    classDef module fill:#f9c5d1,stroke:#922b21,stroke-width:2px;
    classDef api fill:#f7dc6f,stroke:#7d6608,stroke-width:2px;
    classDef build fill:#d5f5e3,stroke:#1e8449,stroke-width:2px;
    classDef external fill:#d6eaf8,stroke:#2471a3,stroke-width:2px;
```
