# hks2002/docs-web architecture

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

- Interactive diagram: https://gitdiagram.com/hks2002/docs-web
- Repository: https://github.com/hks2002/docs-web

## Overview

Docs Web is a browser frontend for a document-library system. The main user flow is login, then browse document listings and access logs, navigate paths, and upload documents; administrators also manage cleanup and user permissions. The graph includes the documented UI, state, localization, API and WebSocket capabilities visible in the tree and excerpts. Several feature implementations are not sampled, so their internal interactions are omitted rather than inferred.

Main entry points: [`src/stores/SessionStore.js`](https://github.com/hks2002/docs-web/blob/master/src/stores/SessionStore.js) (Session state), [`src/pages/LoginPage.vue`](https://github.com/hks2002/docs-web/blob/master/src/pages/LoginPage.vue) (Login), [`src/layouts/PageHeader.vue`](https://github.com/hks2002/docs-web/blob/master/src/layouts/PageHeader.vue) (Navigation header), [`src/router/index.js`](https://github.com/hks2002/docs-web/blob/master/src/router/index.js) (Route guard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_navigation["App navigation"]
  node_routing["Routes<br/>[routes.js]"]
  node_router["Route guard<br/>[index.js]"]
  node_login["Login<br/>[LoginPage.vue]"]
  node_layout["Main layout<br/>[MainLayout.vue]"]
  node_header["Navigation header<br/>[PageHeader.vue]"]
end

subgraph group_docs["Document library"]
  node_index["Library page<br/>[IndexPage.vue]"]
  node_docs_tables["Document tables<br/>[DocsTable0.vue]"]
  node_access_log["Access log<br/>[AccessLog.vue]"]
  node_upload["File upload<br/>[FileUpload.vue]"]
  node_file_helpers["Path and file helpers<br/>[file.js]"]
end

subgraph group_admin["Administration"]
  node_cleanup["Document cleanup<br/>[CleanNonExists.vue]"]
  node_permissions["User permissions<br/>[UserFuncMatrix.vue]"]
  node_drawer["Admin drawer<br/>[RightDrawer.vue]"]
end

subgraph group_platform["Client services"]
  node_session[("Session state<br/>[SessionStore.js]")]
  node_locale_store[("Locale state<br/>[LocaleStore.js]")]
  node_i18n["Localization<br/>[useI18n.js]"]
  node_axios["HTTP client setup<br/>[axios.js]"]
  node_websocket["WebSocket manager<br/>[ws.js]"]
end

node_user(("User"))
node_api{{"Docs API"}}
node_ws_service{{"Docs WebSocket service"}}

node_user -->|"opens routes"| node_router
node_routing -->|"configures"| node_router
node_router -->|"checks session"| node_session
node_user -->|"submits credentials"| node_login
node_login -->|"posts login"| node_api
node_login -->|"sets user state"| node_session
node_login -->|"navigates after login"| node_router
node_routing -->|"routes to"| node_layout
node_layout -->|"renders"| node_header
node_routing -->|"routes to"| node_index
node_index -->|"renders"| node_docs_tables
node_index -->|"renders"| node_access_log
node_header -->|"renders"| node_upload
node_docs_tables -->|"reads state"| node_session
node_docs_tables -->|"uses"| node_file_helpers
node_access_log -->|"uses"| node_file_helpers
node_access_log -.->|"requests log data"| node_api
node_upload -->|"reads state"| node_session
node_upload -.->|"uploads documents"| node_api
node_header -.->|"opens admin drawer"| node_drawer
node_drawer -->|"renders"| node_cleanup
node_drawer -->|"renders"| node_permissions
node_permissions -->|"loads and updates"| node_api
node_permissions -.->|"uses"| node_session
node_cleanup -.->|"requests cleanup"| node_ws_service
node_websocket -->|"connects and exchanges events"| node_ws_service
node_websocket -->|"translates notifications"| node_i18n
node_header -.->|"uses locale controls"| node_locale_store
node_locale_store -.->|"selects language"| node_i18n

click node_routing "https://github.com/hks2002/docs-web/blob/master/src/router/routes.js"
click node_router "https://github.com/hks2002/docs-web/blob/master/src/router/index.js"
click node_login "https://github.com/hks2002/docs-web/blob/master/src/pages/LoginPage.vue"
click node_layout "https://github.com/hks2002/docs-web/blob/master/src/layouts/MainLayout.vue"
click node_header "https://github.com/hks2002/docs-web/blob/master/src/layouts/PageHeader.vue"
click node_index "https://github.com/hks2002/docs-web/blob/master/src/pages/IndexPage.vue"
click node_docs_tables "https://github.com/hks2002/docs-web/blob/master/src/components/DocsTable0.vue"
click node_access_log "https://github.com/hks2002/docs-web/blob/master/src/components/AccessLog.vue"
click node_upload "https://github.com/hks2002/docs-web/blob/master/src/components/FileUpload.vue"
click node_file_helpers "https://github.com/hks2002/docs-web/blob/master/src/utils/file.js"
click node_cleanup "https://github.com/hks2002/docs-web/blob/master/src/components/CleanNonExists.vue"
click node_permissions "https://github.com/hks2002/docs-web/blob/master/src/components/UserFuncMatrix.vue"
click node_drawer "https://github.com/hks2002/docs-web/blob/master/src/layouts/RightDrawer.vue"
click node_session "https://github.com/hks2002/docs-web/blob/master/src/stores/SessionStore.js"
click node_locale_store "https://github.com/hks2002/docs-web/blob/master/src/stores/LocaleStore.js"
click node_i18n "https://github.com/hks2002/docs-web/blob/master/src/composables/useI18n.js"
click node_axios "https://github.com/hks2002/docs-web/blob/master/src/boot/axios.js"
click node_websocket "https://github.com/hks2002/docs-web/blob/master/src/ws/ws.js"

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_routing,node_router,node_login,node_layout,node_header,node_user toneBlue
class node_index,node_docs_tables,node_access_log,node_upload,node_file_helpers toneAmber
class node_cleanup,node_permissions,node_drawer,node_api toneMint
class node_session,node_locale_store,node_i18n,node_axios,node_websocket toneRose
class node_ws_service toneIndigo
```

## Components

### App navigation

- [Routes](https://github.com/hks2002/docs-web/blob/master/src/router/routes.js): `src/router/routes.js`
- [Route guard](https://github.com/hks2002/docs-web/blob/master/src/router/index.js): `src/router/index.js`
- [Login](https://github.com/hks2002/docs-web/blob/master/src/pages/LoginPage.vue): `src/pages/LoginPage.vue`
- [Main layout](https://github.com/hks2002/docs-web/blob/master/src/layouts/MainLayout.vue): `src/layouts/MainLayout.vue`
- [Navigation header](https://github.com/hks2002/docs-web/blob/master/src/layouts/PageHeader.vue): `src/layouts/PageHeader.vue`

### Document library

- [Library page](https://github.com/hks2002/docs-web/blob/master/src/pages/IndexPage.vue): `src/pages/IndexPage.vue`
- [Document tables](https://github.com/hks2002/docs-web/blob/master/src/components/DocsTable0.vue): `src/components/DocsTable0.vue`
- [Access log](https://github.com/hks2002/docs-web/blob/master/src/components/AccessLog.vue): `src/components/AccessLog.vue`
- [File upload](https://github.com/hks2002/docs-web/blob/master/src/components/FileUpload.vue): `src/components/FileUpload.vue`
- [Path and file helpers](https://github.com/hks2002/docs-web/blob/master/src/utils/file.js): `src/utils/file.js`

### Administration

- [Document cleanup](https://github.com/hks2002/docs-web/blob/master/src/components/CleanNonExists.vue): `src/components/CleanNonExists.vue`
- [User permissions](https://github.com/hks2002/docs-web/blob/master/src/components/UserFuncMatrix.vue): `src/components/UserFuncMatrix.vue`
- [Admin drawer](https://github.com/hks2002/docs-web/blob/master/src/layouts/RightDrawer.vue): `src/layouts/RightDrawer.vue`

### Client services

- [Session state](https://github.com/hks2002/docs-web/blob/master/src/stores/SessionStore.js): `src/stores/SessionStore.js`
- [Locale state](https://github.com/hks2002/docs-web/blob/master/src/stores/LocaleStore.js): `src/stores/LocaleStore.js`
- [Localization](https://github.com/hks2002/docs-web/blob/master/src/composables/useI18n.js): `src/composables/useI18n.js`
- [HTTP client setup](https://github.com/hks2002/docs-web/blob/master/src/boot/axios.js): `src/boot/axios.js`
- [WebSocket manager](https://github.com/hks2002/docs-web/blob/master/src/ws/ws.js): `src/ws/ws.js`

### Other components

- **User**
- **Docs API**
- **Docs WebSocket service**

## Connections

- User → Route guard: opens routes
- Routes → Route guard: configures (evidence: `src/router/index.js`)
- Route guard → Session state: checks session (evidence: `src/router/index.js`)
- User → Login: submits credentials (evidence: `src/pages/LoginPage.vue`)
- Login → Docs API: posts login (evidence: `src/pages/LoginPage.vue`)
- Login → Session state: sets user state (evidence: `src/pages/LoginPage.vue`)
- Login → Route guard: navigates after login (evidence: `src/pages/LoginPage.vue`)
- Routes → Main layout: routes to (evidence: `src/router/routes.js`)
- Main layout → Navigation header: renders (evidence: `src/layouts/MainLayout.vue`)
- Routes → Library page: routes to (evidence: `src/router/routes.js`)
- Library page → Document tables: renders (evidence: `src/pages/IndexPage.vue`)
- Library page → Access log: renders (evidence: `src/pages/IndexPage.vue`)
- Navigation header → File upload: renders (evidence: `src/layouts/PageHeader.vue`)
- Document tables → Session state: reads state (evidence: `src/components/DocsTable0.vue`)
- Document tables → Path and file helpers: uses (evidence: `src/components/DocsTable0.vue`)
- Access log → Path and file helpers: uses (evidence: `src/components/AccessLog.vue`)
- Access log → Docs API: requests log data
- File upload → Session state: reads state (evidence: `src/components/FileUpload.vue`)
- File upload → Docs API: uploads documents
- Navigation header → Admin drawer: opens admin drawer
- Admin drawer → Document cleanup: renders (evidence: `src/layouts/RightDrawer.vue`)
- Admin drawer → User permissions: renders (evidence: `src/layouts/RightDrawer.vue`)
- User permissions → Docs API: loads and updates (evidence: `src/components/UserFuncMatrix.vue`)
- User permissions → Session state: uses
- Document cleanup → Docs WebSocket service: requests cleanup
- WebSocket manager → Docs WebSocket service: connects and exchanges events (evidence: `src/ws/ws.js`)
- WebSocket manager → Localization: translates notifications (evidence: `src/ws/ws.js`)
- Navigation header → Locale state: uses locale controls
- Locale state → Localization: selects language
