How lissy93/dashy works
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: router.js Route Guard · app.js Express Server · App.vue Dashy App · main.js App Bootstrap
Components 29
Client Shell
- App Bootstrap
src/main.js - Dashy App
src/App.vue - Route Guard
src/router.js - State Store
src/store.js - Request Client
src/utils/request.js - OIDC Client
src/utils/auth/OidcAuth.js
Configuration
- Remote Config Loader
src/components/Configuration/RemoteConfigLoader.vue - Config Model
src/utils/config/ConfigHelpers.js - Config Editor
src/components/Configuration/ConfigContainer.vue - Config Validator
src/utils/config/validateConfig.js - Cloud Backup
src/utils/CloudBackup.js
Dashboard Experience
- Home View
src/views/Home.vue - Workspace View
src/views/Workspace.vue - Minimal View
src/views/Minimal.vue - Link Renderer
src/components/LinkItems/Section.vue - Widget Renderer
src/components/Widgets/WidgetBase.vue - Search Bar
src/components/Settings/SearchBar.vue - Theme Engine
src/utils/Theming.js
Server API
- Express Server
services/app.js - API Router
services/endpoints/api/index.js - Config API
services/endpoints/api/config-files.js - Status API
services/endpoints/status-check.js - System Info API
services/endpoints/system-info.js - OIDC Verifier
services/utils/auth-oidc.js
External Integrations
- OIDC Provider
- Configured Services
- Backup Service
- Web Destinations
Other components
- User
Connections 29
- 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