# vbenjs/vue-vben-admin architecture

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

- Interactive diagram: https://gitdiagram.com/vbenjs/vue-vben-admin
- Repository: https://github.com/vbenjs/vue-vben-admin

## Overview

Vue Vben Admin is a Vue 3 middle- and back-office admin template, offered as several UI-library variants. The principal workflow initializes app preferences, bootstraps the chosen frontend, and renders authenticated or public routes and their views; permissions support dynamic route generation. The graph also preserves documented themes and internationalization, plus the mock API and shared UI/runtime layers. Source excerpts and the index establish initialization links; unsampled route, API, and mock-handler connections are omitted rather than inferred.

Main entry points: [`apps/web-antd/src/bootstrap.ts`](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/bootstrap.ts) (App bootstrap), [`apps/web-antd/src/main.ts`](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/main.ts) (App entry), [`packages/@core/base/shared/src/cache/storage-manager.ts`](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/storage-manager.ts) (Storage manager), [`apps/web-antd/src/router/access.ts`](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/router/access.ts) (Route access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Admin frontends"]
  node_entry["App entry<br/>[main.ts]"]
  node_bootstrap["App bootstrap<br/>[bootstrap.ts]"]
  node_uiadapter["UI adapters<br/>[index.ts]"]
  node_appconfig["Theme and locale<br/>[app.vue]"]
end

subgraph group_domain["Admin experience"]
  node_routing["Route access<br/>[access.ts]"]
  node_authview["Authentication views<br/>[login.vue]"]
  node_authstate["Authentication state<br/>[auth.ts]"]
  node_layouts["Admin layouts<br/>[basic.vue]"]
  node_dashboard["Dashboard views<br/>[index.vue]"]
  node_profile["Profile settings<br/>[index.vue]"]
end

subgraph group_shared["Shared runtime"]
  node_preferences["App preferences<br/>[preferences.ts]"]
  node_routegen["Dynamic routes"]
  node_api["Core API clients<br/>[auth.ts]"]
  node_request["Request client<br/>[request-client.ts]"]
  node_forms["Form runtime<br/>[form-runtime.ts]"]
  node_storage["Storage manager<br/>[storage-manager.ts]"]
  node_localstorage["Browser storage"]
  node_memstorage["Memory storage"]
end

subgraph group_mock["Mock services"]
  node_mockapi["Mock API routes<br/>[login.post.ts]"]
  node_mockdata["Mock data<br/>[mock-data.ts]"]
end

node_user(("Admin user"))

node_user -->|"opens app"| node_entry
node_entry -->|"initializes"| node_preferences
node_entry -->|"loads and starts"| node_bootstrap
node_bootstrap -->|"uses"| node_preferences
node_bootstrap -->|"loads"| node_uiadapter
node_bootstrap -->|"loads router"| node_routing
node_bootstrap -->|"mounts app"| node_appconfig
node_routing -.->|"generates permitted routes"| node_routegen
node_user -->|"signs in"| node_authview
node_user -->|"uses admin UI"| node_layouts
node_user -->|"views dashboard"| node_dashboard
node_user -.->|"updates profile"| node_profile
node_api -.->|"uses client"| node_request
node_user -.->|"requests mock service"| node_mockapi
node_mockapi -.->|"uses mock data"| node_mockdata
node_storage -->|"defaults to browser driver"| node_localstorage
node_storage -->|"falls back to memory"| node_memstorage

click node_entry "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/main.ts"
click node_bootstrap "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/bootstrap.ts"
click node_uiadapter "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/adapter/component/index.ts"
click node_preferences "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/preferences/src/preferences.ts"
click node_appconfig "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/app.vue"
click node_routing "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/router/access.ts"
click node_routegen "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/utils/src/helpers/generate-routes-backend.ts"
click node_authview "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/_core/authentication/login.vue"
click node_authstate "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/store/auth.ts"
click node_layouts "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/layouts/basic.vue"
click node_dashboard "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/dashboard/analytics/index.vue"
click node_profile "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/_core/profile/index.vue"
click node_api "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/api/core/auth.ts"
click node_request "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/effects/request/src/request-client/request-client.ts"
click node_forms "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/ui-kit/form-ui/src/form-runtime.ts"
click node_mockapi "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/backend-mock/api/auth/login.post.ts"
click node_mockdata "https://github.com/vbenjs/vue-vben-admin/blob/main/apps/backend-mock/utils/mock-data.ts"
click node_storage "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/storage-manager.ts"
click node_localstorage "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/local-storage-driver.ts"
click node_memstorage "https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/memory-storage-driver.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_bootstrap,node_uiadapter,node_appconfig,node_user toneBlue
class node_routing,node_authview,node_authstate,node_layouts,node_dashboard,node_profile toneAmber
class node_preferences,node_routegen,node_api,node_request,node_forms,node_storage,node_localstorage,node_memstorage toneMint
class node_mockapi,node_mockdata toneRose
```

## Components

### Admin frontends

- [App entry](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/main.ts): `apps/web-antd/src/main.ts`
- [App bootstrap](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/bootstrap.ts): `apps/web-antd/src/bootstrap.ts`
- [UI adapters](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/adapter/component/index.ts): `apps/web-antd/src/adapter/component/index.ts`
- [Theme and locale](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/app.vue): `apps/web-antd/src/app.vue`

### Admin experience

- [Route access](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/router/access.ts): `apps/web-antd/src/router/access.ts`
- [Authentication views](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/_core/authentication/login.vue): `apps/web-antd/src/views/_core/authentication/login.vue`
- [Authentication state](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/store/auth.ts): `apps/web-antd/src/store/auth.ts`
- [Admin layouts](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/layouts/basic.vue): `apps/web-antd/src/layouts/basic.vue`
- [Dashboard views](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/dashboard/analytics/index.vue): `apps/web-antd/src/views/dashboard/analytics/index.vue`
- [Profile settings](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/views/_core/profile/index.vue): `apps/web-antd/src/views/_core/profile/index.vue`

### Shared runtime

- [App preferences](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/preferences/src/preferences.ts): `packages/@core/preferences/src/preferences.ts`
- [Dynamic routes](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/utils/src/helpers/generate-routes-backend.ts): `packages/utils/src/helpers/generate-routes-backend.ts`
- [Core API clients](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/web-antd/src/api/core/auth.ts): `apps/web-antd/src/api/core/auth.ts`
- [Request client](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/effects/request/src/request-client/request-client.ts): `packages/effects/request/src/request-client/request-client.ts`
- [Form runtime](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/ui-kit/form-ui/src/form-runtime.ts): `packages/@core/ui-kit/form-ui/src/form-runtime.ts`
- [Storage manager](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/storage-manager.ts): `packages/@core/base/shared/src/cache/storage-manager.ts`
- [Browser storage](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/local-storage-driver.ts): `packages/@core/base/shared/src/cache/local-storage-driver.ts`
- [Memory storage](https://github.com/vbenjs/vue-vben-admin/blob/main/packages/%40core/base/shared/src/cache/memory-storage-driver.ts): `packages/@core/base/shared/src/cache/memory-storage-driver.ts`

### Mock services

- [Mock API routes](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/backend-mock/api/auth/login.post.ts): `apps/backend-mock/api/auth/login.post.ts`
- [Mock data](https://github.com/vbenjs/vue-vben-admin/blob/main/apps/backend-mock/utils/mock-data.ts): `apps/backend-mock/utils/mock-data.ts`

### Other components

- **Admin user**

## Connections

- Admin user → App entry: opens app (evidence: `README.md`)
- App entry → App preferences: initializes (evidence: `apps/web-antd/src/main.ts`)
- App entry → App bootstrap: loads and starts (evidence: `apps/web-antd/src/main.ts`)
- App bootstrap → App preferences: uses (evidence: `apps/web-antd/src/bootstrap.ts`)
- App bootstrap → UI adapters: loads (evidence: `apps/web-antd/src/bootstrap.ts`)
- App bootstrap → Route access: loads router (evidence: `apps/web-antd/src/bootstrap.ts`)
- App bootstrap → Theme and locale: mounts app (evidence: `apps/web-antd/src/bootstrap.ts`)
- Route access → Dynamic routes: generates permitted routes
- Admin user → Authentication views: signs in (evidence: `README.md`)
- Admin user → Admin layouts: uses admin UI (evidence: `README.md`)
- Admin user → Dashboard views: views dashboard (evidence: `README.md`)
- Admin user → Profile settings: updates profile
- Core API clients → Request client: uses client
- Admin user → Mock API routes: requests mock service
- Mock API routes → Mock data: uses mock data
- Storage manager → Browser storage: defaults to browser driver (evidence: `packages/@core/base/shared/src/cache/storage-manager.ts`)
- Storage manager → Memory storage: falls back to memory (evidence: `packages/@core/base/shared/src/cache/storage-manager.ts`)
