Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

:memo: Updates directory listing, and removes component section

Alicia Sykesa442b3dbe206
diff --git a/docs/developing.md b/docs/developing.md
index 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