# lissy93/dashy architecture

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

- Interactive diagram: https://gitdiagram.com/lissy93/dashy
- Repository: https://github.com/lissy93/dashy

## Overview

Dashy is a customizable self-hosted homepage. A user opens the Vue application, which initializes authentication and configuration, routes to a dashboard view, renders links and service widgets, and supports search, themes, workspace/minimal views, and interactive editing. Edits are validated and saved through the Express API; status widgets query configured services. The README also documents cloud backup, multi-page navigation, localization, and offline support. Arrows reflect sampled source and explicit README capabilities; several widget implementations are represented at directory level.

Main entry points: [`src/router.js`](https://github.com/lissy93/dashy/blob/master/src/router.js) (Route Guard), [`services/app.js`](https://github.com/lissy93/dashy/blob/master/services/app.js) (Express Server), [`src/App.vue`](https://github.com/lissy93/dashy/blob/master/src/App.vue) (Dashy App), [`src/main.js`](https://github.com/lissy93/dashy/blob/master/src/main.js) (App Bootstrap)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client Shell"]
  node_bootstrap["App Bootstrap<br/>[main.js]"]
  node_app["Dashy App<br/>[App.vue]"]
  node_router["Route Guard<br/>[router.js]"]
  node_store["State Store<br/>[store.js]"]
  node_request["Request Client<br/>[request.js]"]
  node_authclient["OIDC Client<br/>[OidcAuth.js]"]
end

subgraph group_config["Configuration"]
  node_configloader["Remote Config Loader"]
  node_configmodel["Config Model<br/>[ConfigHelpers.js]"]
  node_editor["Config Editor"]
  node_validator["Config Validator<br/>[validateConfig.js]"]
  node_cloudbackup["Cloud Backup<br/>[CloudBackup.js]"]
end

subgraph group_dashboard["Dashboard Experience"]
  node_home["Home View<br/>[Home.vue]"]
  node_workspace["Workspace View<br/>[Workspace.vue]"]
  node_minimal["Minimal View<br/>[Minimal.vue]"]
  node_links["Link Renderer<br/>[Section.vue]"]
  node_widgets["Widget Renderer<br/>[WidgetBase.vue]"]
  node_search["Search Bar<br/>[SearchBar.vue]"]
  node_theme["Theme Engine<br/>[Theming.js]"]
end

subgraph group_server["Server API"]
  node_server["Express Server<br/>[app.js]"]
  node_api["API Router<br/>[index.js]"]
  node_configapi["Config API<br/>[config-files.js]"]
  node_statusapi["Status API<br/>[status-check.js]"]
  node_systemapi["System Info API<br/>[system-info.js]"]
  node_serverauth["OIDC Verifier<br/>[auth-oidc.js]"]
end

subgraph group_integrations["External Integrations"]
  node_oidcprovider{{"OIDC Provider"}}
  node_configuredservices{{"Configured Services"}}
  node_cloudservice{{"Backup Service"}}
  node_webdestinations{{"Web Destinations"}}
end

node_user(("User"))

node_user -->|"opens app"| node_bootstrap
node_bootstrap -.->|"initializes auth"| node_authclient
node_authclient -.->|"authenticates with"| node_oidcprovider
node_bootstrap -->|"mounts app"| node_app
node_app -->|"renders routes"| node_router
node_router -->|"initializes config"| node_store
node_router -->|"routes home"| node_home
node_router -->|"routes workspace"| node_workspace
node_router -->|"routes minimal"| node_minimal
node_app -->|"loads config"| node_configloader
node_configloader -->|"requests config"| node_request
node_configloader -->|"builds config"| node_configmodel
node_home -->|"renders links"| node_links
node_home -->|"renders widgets"| node_widgets
node_workspace -->|"renders widgets"| node_widgets
node_minimal -->|"provides search"| node_search
node_search -->|"opens destinations"| node_webdestinations
node_app -->|"applies theme"| node_theme
node_editor -->|"validates edits"| node_validator
node_editor -->|"saves config"| node_configapi
node_cloudbackup -.->|"backs up config"| node_cloudservice
node_request -->|"sends requests"| node_server
node_server -->|"dispatches API"| node_api
node_api -->|"dispatches config"| node_configapi
node_server -->|"serves status"| node_statusapi
node_server -->|"serves system info"| node_systemapi
node_server -->|"verifies tokens"| node_serverauth
node_serverauth -.->|"fetches keys"| node_oidcprovider
node_statusapi -->|"checks services"| node_configuredservices

click node_bootstrap "https://github.com/lissy93/dashy/blob/master/src/main.js"
click node_app "https://github.com/lissy93/dashy/blob/master/src/App.vue"
click node_router "https://github.com/lissy93/dashy/blob/master/src/router.js"
click node_store "https://github.com/lissy93/dashy/blob/master/src/store.js"
click node_request "https://github.com/lissy93/dashy/blob/master/src/utils/request.js"
click node_authclient "https://github.com/lissy93/dashy/blob/master/src/utils/auth/OidcAuth.js"
click node_configloader "https://github.com/lissy93/dashy/blob/master/src/components/Configuration/RemoteConfigLoader.vue"
click node_configmodel "https://github.com/lissy93/dashy/blob/master/src/utils/config/ConfigHelpers.js"
click node_editor "https://github.com/lissy93/dashy/blob/master/src/components/Configuration/ConfigContainer.vue"
click node_validator "https://github.com/lissy93/dashy/blob/master/src/utils/config/validateConfig.js"
click node_cloudbackup "https://github.com/lissy93/dashy/blob/master/src/utils/CloudBackup.js"
click node_home "https://github.com/lissy93/dashy/blob/master/src/views/Home.vue"
click node_workspace "https://github.com/lissy93/dashy/blob/master/src/views/Workspace.vue"
click node_minimal "https://github.com/lissy93/dashy/blob/master/src/views/Minimal.vue"
click node_links "https://github.com/lissy93/dashy/blob/master/src/components/LinkItems/Section.vue"
click node_widgets "https://github.com/lissy93/dashy/blob/master/src/components/Widgets/WidgetBase.vue"
click node_search "https://github.com/lissy93/dashy/blob/master/src/components/Settings/SearchBar.vue"
click node_theme "https://github.com/lissy93/dashy/blob/master/src/utils/Theming.js"
click node_server "https://github.com/lissy93/dashy/blob/master/services/app.js"
click node_api "https://github.com/lissy93/dashy/blob/master/services/endpoints/api/index.js"
click node_configapi "https://github.com/lissy93/dashy/blob/master/services/endpoints/api/config-files.js"
click node_statusapi "https://github.com/lissy93/dashy/blob/master/services/endpoints/status-check.js"
click node_systemapi "https://github.com/lissy93/dashy/blob/master/services/endpoints/system-info.js"
click node_serverauth "https://github.com/lissy93/dashy/blob/master/services/utils/auth-oidc.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_bootstrap,node_app,node_router,node_store,node_request,node_authclient,node_user toneBlue
class node_configloader,node_configmodel,node_editor,node_validator,node_cloudbackup toneAmber
class node_home,node_workspace,node_minimal,node_links,node_widgets,node_search,node_theme toneMint
class node_server,node_api,node_configapi,node_statusapi,node_systemapi,node_serverauth toneRose
class node_oidcprovider,node_configuredservices,node_cloudservice,node_webdestinations toneIndigo
```

## Components

### Client Shell

- [App Bootstrap](https://github.com/lissy93/dashy/blob/master/src/main.js): `src/main.js`
- [Dashy App](https://github.com/lissy93/dashy/blob/master/src/App.vue): `src/App.vue`
- [Route Guard](https://github.com/lissy93/dashy/blob/master/src/router.js): `src/router.js`
- [State Store](https://github.com/lissy93/dashy/blob/master/src/store.js): `src/store.js`
- [Request Client](https://github.com/lissy93/dashy/blob/master/src/utils/request.js): `src/utils/request.js`
- [OIDC Client](https://github.com/lissy93/dashy/blob/master/src/utils/auth/OidcAuth.js): `src/utils/auth/OidcAuth.js`

### Configuration

- [Remote Config Loader](https://github.com/lissy93/dashy/blob/master/src/components/Configuration/RemoteConfigLoader.vue): `src/components/Configuration/RemoteConfigLoader.vue`
- [Config Model](https://github.com/lissy93/dashy/blob/master/src/utils/config/ConfigHelpers.js): `src/utils/config/ConfigHelpers.js`
- [Config Editor](https://github.com/lissy93/dashy/blob/master/src/components/Configuration/ConfigContainer.vue): `src/components/Configuration/ConfigContainer.vue`
- [Config Validator](https://github.com/lissy93/dashy/blob/master/src/utils/config/validateConfig.js): `src/utils/config/validateConfig.js`
- [Cloud Backup](https://github.com/lissy93/dashy/blob/master/src/utils/CloudBackup.js): `src/utils/CloudBackup.js`

### Dashboard Experience

- [Home View](https://github.com/lissy93/dashy/blob/master/src/views/Home.vue): `src/views/Home.vue`
- [Workspace View](https://github.com/lissy93/dashy/blob/master/src/views/Workspace.vue): `src/views/Workspace.vue`
- [Minimal View](https://github.com/lissy93/dashy/blob/master/src/views/Minimal.vue): `src/views/Minimal.vue`
- [Link Renderer](https://github.com/lissy93/dashy/blob/master/src/components/LinkItems/Section.vue): `src/components/LinkItems/Section.vue`
- [Widget Renderer](https://github.com/lissy93/dashy/blob/master/src/components/Widgets/WidgetBase.vue): `src/components/Widgets/WidgetBase.vue`
- [Search Bar](https://github.com/lissy93/dashy/blob/master/src/components/Settings/SearchBar.vue): `src/components/Settings/SearchBar.vue`
- [Theme Engine](https://github.com/lissy93/dashy/blob/master/src/utils/Theming.js): `src/utils/Theming.js`

### Server API

- [Express Server](https://github.com/lissy93/dashy/blob/master/services/app.js): `services/app.js`
- [API Router](https://github.com/lissy93/dashy/blob/master/services/endpoints/api/index.js): `services/endpoints/api/index.js`
- [Config API](https://github.com/lissy93/dashy/blob/master/services/endpoints/api/config-files.js): `services/endpoints/api/config-files.js`
- [Status API](https://github.com/lissy93/dashy/blob/master/services/endpoints/status-check.js): `services/endpoints/status-check.js`
- [System Info API](https://github.com/lissy93/dashy/blob/master/services/endpoints/system-info.js): `services/endpoints/system-info.js`
- [OIDC Verifier](https://github.com/lissy93/dashy/blob/master/services/utils/auth-oidc.js): `services/utils/auth-oidc.js`

### External Integrations

- **OIDC Provider**
- **Configured Services**
- **Backup Service**
- **Web Destinations**

### Other components

- **User**

## Connections

- User → App Bootstrap: opens app
- App Bootstrap → OIDC Client: initializes auth
- OIDC Client → OIDC Provider: authenticates with
- App Bootstrap → Dashy App: mounts app
- Dashy App → Route Guard: renders routes
- Route Guard → State Store: initializes config
- Route Guard → Home View: routes home
- Route Guard → Workspace View: routes workspace
- Route Guard → Minimal View: routes minimal
- Dashy App → Remote Config Loader: loads config
- Remote Config Loader → Request Client: requests config
- Remote Config Loader → Config Model: builds config
- Home View → Link Renderer: renders links
- Home View → Widget Renderer: renders widgets
- Workspace View → Widget Renderer: renders widgets
- Minimal View → Search Bar: provides search
- Search Bar → Web Destinations: opens destinations
- Dashy App → Theme Engine: applies theme
- Config Editor → Config Validator: validates edits
- Config Editor → Config API: saves config
- Cloud Backup → Backup Service: backs up config
- Request Client → Express Server: sends requests
- Express Server → API Router: dispatches API
- API Router → Config API: dispatches config
- Express Server → Status API: serves status
- Express Server → System Info API: serves system info
- Express Server → OIDC Verifier: verifies tokens
- OIDC Verifier → OIDC Provider: fetches keys
- Status API → Configured Services: checks services
