π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
:memo: Updates directory listing, and removes component section
Alicia Sykesa442b3dbe206
diff --git a/docs/developing.md b/docs/developing.mdindex 7206325f..26b92d27 100644--- a/docs/developing.md+++ b/docs/developing.md@@ -219,6 +219,7 @@ Styleguides:βββ components # All front-end Vue web componentsβ βββ Configuration # Components relating to the user config pop-upβ β βββ AppInfoModal.vue # A modal showing core app info, like version, language, etc+β β βββ AppVersion.vue # Shows current version from package.json, compares with GitHubβ β βββ CloudBackupRestore.vue # Form where the user manages cloud sync optionsβ β βββ ConfigContainer.vue # Main container, wrapping all other config componentsβ β βββ CustomCss.vue # Form where the user can input custom CSS@@ -237,14 +238,24 @@ Styleguides:β β βββ ItemIcon.vue # The icon used by both items and sectionsβ β βββ ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening methodβ β β°ββ StatusIndicator.vue # Traffic light dot, showing if app is online or down+β βββ Minimal View # Components used for the startpage / minimal alternative view+β β βββ MinimalHeading.vue # Title part of minimal view+β β βββ MinimalSearch.vue # Search bar for minimal view+β β β°ββ MinimalSection.vue # Tabbed-Item section for minimal viewβ βββ PageStrcture # Components relating the main structure of the pageβ β βββ Footer.vue # Footer, visible at the bottom of all pagesβ β βββ Header.vue # Header, visible at the top of pages, and includes title and navβ β βββ LoadingScreen.vue # Splash screen shown on first loadβ β βββ Nav.vue # Navigation bar, includes a list of linksβ β β°ββ PageTitle.vue # Page title and sub-title, visible within the Header+β βββ Workspace # Components used for the multi-tasking/ Workspace view+β β βββ MultiTaskingWeb.vue # When multi-tasking enabled, generates new iframe+β β βββ SideBar.vue # The left sidebar for the workspace view+β β βββ SideBarItem.vue # App item for the sidebar view+β β βββ SideBarSection.vue # Collapsible collection of items within workspace sidebar+β β β°ββ WebContent.vue # Workspace iframe view, displays content of current appβ β°ββ Settings # Components relating to the quick-settings, in the top-right-β βββ AuthButtons.vue # Logout button and other app info+β βββ AuthButtons.vue # Logout button and other app infoβ βββ ConfigLauncher.vue # Icon that when clicked will launch the Configuration componentβ βββ CustomThemeMaker.vue # Color pickers for letting user build their own themeβ βββ ItemSizeSelector.vue # Set of buttons used to set and save item size@@ -261,14 +272,21 @@ Styleguides:βββ utils # Directory of re-used helper functionsβ βββ ArrowKeyNavigation.js # Functionality for arrow-key navigationβ βββ Auth.js # Handles all authentication related actions+β βββ CheckSectionVisibility.js # Checks which parts of the page should be visible/ hidden based on configβ βββ ClickOutside.js # A directive for detecting click, used to hide dropdown, modal or context menu-β βββ ConfigAccumulator.js # Central place for managing and combining configβ βββ ConfigHelpers.js # Helper functions for managing configurationβ βββ CloudBackup.js # Functionality for encrypting, processing and network callsβ βββ ConfigSchema.json # The schema, used to validate the users conf.yml file+β βββ ConfigAccumulator.js # Central place for managing and combining config+β βββ ConfigHelpers.json # Collection of helper functions to process config using accumulatorβ βββ ConfigValidator.js # A helper script that validates the config file against schema+β βββ CoolConsole.js # Prints info, warning and error messages to browser console, with a cool styleβ βββ defaults.js # Global constants and their default values+β βββ emojis.json # List of emojis with unicode and shortcode, used for emoji icon feature+β βββ EmojiUnicodeRegex.js # Regular expression to validate emoji unicode format, for emoji iconsβ βββ ErrorHandler.js # Helper function called when an error is returned+β βββ InitServiceWorker.js # Initializes and manages service worker, if enabled+β βββ Search.js # Helper functions for searching/ filtering items in all viewsβ βββ JsonToYaml.js # Function that parses and converts raw JSON into valid YAMLβ βββ languages.js # Handles fetching, switching and validating languagesβ β°ββ ThemeHelper.js # Function that handles the fetching and setting of user themes@@ -280,24 +298,6 @@ Styleguides:β°ββ Workspace.vue # The workspace view with apps in sidebar```-### Frontend Components--All frontend code is located in the `./src` directory, which is split into 5 sub-folders:-- **Components** - All frontend web components are located here. Each component should have a distinct, well defined and simple task, and ideally should not be too long. The components directory is organised into a series of sub-directories, representing a specific area of the application- - **PageStrcture** - Components relating to overall page structure (nav, footer, etc)- - FormElements - Reusable form elements (button, input field, etc)- - LinkItems - Components relating to Dashy's sections and items (item group, item, item icon, etc)- - Configuration - Components relating to Dashy's configuration forms (cloud backup, JSON editor, etc)-- **Views** - Each view directly corresponds to a route (defined in the router), and in effectively a page. They should have minimal logic, and just contain a few components-- **Utils** - These are helper functions, or logic that is used within the app does not include an UI elements-- **Styles** - Any SCSS that is used globally throughout that app, and is not specific to a single component goes here. This includes variables, color themes, typography settings, CSS reset and media queries-- **Assets** - Static assets that need to be bundled into the application, but do not require any manipulation go here. This includes interface icons and fonts--The structure of the components directory is similar to that of the frontend application layout--<p align="center"><img src="https://i.ibb.co/wJCt0Lq/dashy-page-structure.png" width="600"/></p>-----## Development Tools