# arco-design/arco-design-pro-vue architecture

> Architecture diagram of the GitHub repository arco-design/arco-design-pro-vue, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arco-design/arco-design-pro-vue
- Repository: https://github.com/arco-design/arco-design-pro-vue

## Overview

##### Project type and purpose
- This repository is a CLI tool plus a Vue 3/Vite-based starter template (“arco‑design‑pro‑vite”) for enterprise applications.
- The CLI (in `.arco-cli/` and `scripts/`) bootstraps new projects; the template folder contains a fully configured frontend project using TypeScript, Vue3, Pinia, Arco Design Vue, ECharts, mock APIs, and i18n.

##### High‑level components
a. CLI Layer
- `.arco-cli/init.js` & `scripts/*.js`: orchestrate project creation, copying the template, customizing .env files, running install hooks.
- `scripts/install.js`, `postpublish.js`, etc.: lifecycle scripts for installing/deploying.
b. Template Project (“arco‑design‑pro‑vite”)
- Build & Config
– Vite configs (`config/vite.config.*.ts`), Babel, ESLint/Stylelint, Prettier, CommitLint, Husky.
– Vite plugins (`config/plugin/*.ts`): ArcoResolver, style importer, image minifier, visualizer, compressor.
- Source Code
– Entry point: `src/main.ts` → `App.vue`
– Routing: `src/router` with guards, dynamic routes, external modules.
– State Management: Pinia stores under `src/store/modules/*`.
– API Layer & Mock: `src/api/*.ts` + `src/mock/*.ts` + `src/utils/setup-mock.ts`.
– Internationalization: `src/locale/*` & component‑level locale.
– Utilities & Hooks: `src/utils/*`, `src/hooks/*`.
- Assets & Styles: `src/assets/images`, `.less` styles, global variables.
c. External Dependencies & Services
- Arco Design Vue component library
- ECharts for charts
- Browser (runtime)
- Optional real API backend (mocked in dev)

##### Relationships & Data Flows
- Developer invokes `arco init` (CLI Layer) → CLI reads `init.js`, runs hooks, copies template → NPM/PNPM installs dependencies (install scripts run).
- At build time, Vite loads `vite.config.*`, applies plugins → bundles source code → outputs static assets.
- At runtime in the browser:
- `main.ts` mounts Vue app → initializes router and store → user navigates to a view → view component dispatches store actions or calls API functions in `src/api`.
- In development, `setup-mock` intercepts requests and returns mock data; in production, calls go to real backend endpoints.
- Components render data, use ECharts or Arco components, dispatch state updates (Pinia).
- I18n hooks switch locales.

##### Architectural patterns & principles
- Modular by feature (views, components, store modules)
- Clear separation of concerns: UI, state, routing, API, build config, mocks, scripts
- Plugin‑based build pipeline: each plugin in Vite handles one responsibility (style import, asset compression, bundle visualization).
- Convention over configuration: standardized folder names, file patterns.

1. Build & Scaffold Layer
- CLI tool → Template + Scripts → Vite & plugins → Bundled Output
2. Runtime Application Layer
- Browser/Client → Vue App (main.ts)
- Inside Vue App: Router, Store (Pinia), API/Mock layer, UI Components, Hooks, i18n
3. External Integration
- Arco Design Vue & ECharts (external libraries)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Scaffold Layer
    subgraph "Build & Scaffold Layer"
        direction TB
        CLI["CLI Init Script"]:::build
        CLI2["CLI Post-Init Hook"]:::build
        subgraph "Lifecycle Scripts"
            direction TB
            Install["scripts/install.js"]:::build
            PrePublish["scripts/prepublish.js"]:::build
            PostPublish["scripts/postpublish.js"]:::build
            CRA["scripts/cra.js"]:::build
            Nuxt["scripts/nuxt.js"]:::build
            ViteScript["scripts/vite.js"]:::build
        end
        subgraph "Template Project"
            direction TB
            subgraph "Vite Config"
                direction TB
                ViteBase["vite.config.base.ts"]:::build
                ViteDev["vite.config.dev.ts"]:::build
                ViteProd["vite.config.prod.ts"]:::build
            end
            subgraph "Vite Plugins"
                direction TB
                ArcoResolver["arcoResolver.ts"]:::plugin
                StyleImport["arcoStyleImport.ts"]:::plugin
                Compress["compress.ts"]:::plugin
                Imagemin["imagemin.ts"]:::plugin
                Visualizer["visualizer.ts"]:::plugin
            end
            Bundler["Bundled Output"]:::build
        end
    end

    %% Runtime Application Layer
    subgraph "Runtime Application Layer"
        direction TB
        Browser["Browser/Client"]:::external
        Browser -->|"loads"| Main["main.ts"]:::runtime
        Main --> App["App.vue"]:::runtime
        subgraph "Vue App"
            direction TB
            Router["Router Module"]:::runtime
            Store["Pinia Store"]:::runtime
            subgraph "API & Mock"
                direction TB
                API["API Layer"]:::runtime
                MockServer["Mock API Server"]:::mock
            end
            subgraph "UI Layer"
                direction TB
                Views["src/views"]:::runtime
                Components["src/components"]:::runtime
            end
            subgraph "Utilities & Hooks"
                direction TB
                Utils["src/utils"]:::runtime
                Hooks["src/hooks"]:::runtime
            end
            I18n["i18n"]:::runtime
            Assets["Assets & Styles"]:::runtime
            Types["Type Definitions"]:::runtime
            Directives["Directives"]:::runtime
        end
        App --> Router
        App --> Store
        App --> Views
        App --> Components
        App --> Utils
        App --> Hooks
        App --> I18n
        App --> Assets
        App --> Types
        App --> Directives
        Router -->|"route change"| Views
        Views -->|"dispatch"| Store
        Views -->|"call"| API
        API -->|"/api/*"| MockServer
        MockServer -.->|"mock data"| Views
    end

    %% External Integration
    subgraph "External Integration"
        direction TB
        ArcoLib["Arco Design Vue"]:::third
        ECharts["ECharts"]:::third
        Backend["Real Backend"]:::external
    end
    Components --> ArcoLib
    Components --> ECharts
    API -->|"HTTP request"| Backend

    %% Click Events
    click CLI "https://github.com/arco-design/arco-design-pro-vue/blob/main/.arco-cli/init.js"
    click CLI2 "https://github.com/arco-design/arco-design-pro-vue/blob/main/.arco-cli/after-init.js"
    click Install "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/install.js"
    click PrePublish "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/prepublish.js"
    click PostPublish "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/postpublish.js"
    click CRA "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/cra.js"
    click Nuxt "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/nuxt.js"
    click ViteScript "https://github.com/arco-design/arco-design-pro-vue/blob/main/scripts/vite.js"
    click ViteBase "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/vite.config.base.ts"
    click ViteDev "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/vite.config.dev.ts"
    click ViteProd "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/vite.config.prod.ts"
    click ArcoResolver "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/plugin/arcoResolver.ts"
    click StyleImport "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/plugin/arcoStyleImport.ts"
    click Compress "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/plugin/compress.ts"
    click Imagemin "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/plugin/imagemin.ts"
    click Visualizer "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/config/plugin/visualizer.ts"
    click Main "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/src/main.ts"
    click App "https://github.com/arco-design/arco-design-pro-vue/blob/main/arco-design-pro-vite/src/App.vue"

    %% Styles
    classDef build fill:#dddddd,stroke:#888888,color:#333333
    classDef plugin fill:#cccccc,stroke:#666666,color:#333333
    classDef runtime fill:#eef6ff,stroke:#2a69ac,color:#1e3a8a
    classDef external fill:#e6ffed,stroke:#22863a,color:#036d22
    classDef third fill:#e0f7fa,stroke:#0097a7,color:#006064
    classDef mock fill:#fff4e6,stroke:#f08c00,color:#873800
```
