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!

πŸ“ Updates file links and references

Alicia Sykes51be01d07f70
diff --git a/docs/authentication/zitadel.md b/docs/authentication/zitadel.md
index 54d14a80..bc12e697 100644
--- a/docs/authentication/zitadel.md
+++ b/docs/authentication/zitadel.md
@@ -109,7 +109,7 @@ First boot runs the database migrations and creates the org, admin user, and a m
## 2. Configure Zitadel
-Steps below are the manual UI walkthrough. There's also a Management API for scripted setup; an example bootstrap script is at [`alicia-notes/zitadel/configure.sh`](https://github.com/lissy93/dashy/blob/4.1.5/alicia-notes/zitadel/configure.sh) in the source repo.
+Steps below are the manual UI walkthrough. Zitadel also has a Management API if you'd rather script the setup.
### Create the project
diff --git a/docs/credits.md b/docs/credits.md
index ae2712b6..cf9aa8dc 100644
--- a/docs/credits.md
+++ b/docs/credits.md
@@ -23,12 +23,11 @@ This app definitely wouldn't have been quite so possible without the making use
### Core
-At it's core, the application uses [**Vue.js**](https://github.com/vuejs/vue), as well as it's services with [**VueX**](https://vuex.vuejs.org/) for state management. Styling is done with [**SCSS**](https://github.com/sass/sass), JavaScript is currently [**Babel**](https://github.com/babel/babel), (but I am in the process of converting to [**TypeScript**](https://github.com/Microsoft/TypeScript)). Linting is done with [**ESLint**](https://github.com/eslint/eslint) and [**Prettier**](https://prettier.io/), both following the [**AirBnB Styleguide**](https://github.com/airbnb/javascript). The config is defined in [**YAML**](https://github.com/yaml/yaml), with a simple [**Node.js**](https://github.com/nodejs/node) server to serve up the static app and the optional API endpoints, and container deployment is done with [**Docker**](https://www.docker.com/).
+At it's core, the application uses [**Vue.js**](https://github.com/vuejs/core), as well as it's services with [**VueX**](https://vuex.vuejs.org/) for state management. Styling is done with [**SCSS**](https://github.com/sass/sass), the app is written in [**TypeScript**](https://github.com/Microsoft/TypeScript) and JavaScript, and bundled with [**Vite**](https://github.com/vitejs/vite). Linting is done with [**ESLint**](https://github.com/eslint/eslint) and [**Prettier**](https://prettier.io/), both following the [**AirBnB Styleguide**](https://github.com/airbnb/javascript). The config is defined in [**YAML**](https://github.com/yaml/yaml), with a simple [**Node.js**](https://github.com/nodejs/node) server to serve up the static app and the optional API endpoints, and container deployment is done with [**Docker**](https://www.docker.com/).
### Utilities
- [`crypto-js`](https://github.com/brix/crypto-js) - Encryption implementations by @evanvosberg and community `MIT`
-- [`axios`](https://github.com/axios/axios) - Promise based HTTP client by @mzabriskie and community `MIT`
- [`ajv`](https://github.com/ajv-validator/ajv) - JSON schema Validator by @epoberezkin and community `MIT`
- [`i18n`](https://github.com/kazupon/vue-i18n) - Internationalization plugin by @kazupon and community `MIT`
- [`frappe-charts`](https://github.com/frappe/charts) - Lightweight charting library by @frappe `MIT`
@@ -36,12 +35,6 @@ At it's core, the application uses [**Vue.js**](https://github.com/vuejs/vue), a
### Frontend Components
- [`vue-select`](https://github.com/sagalbot/vue-select) - Dropdown component by @sagalbot `MIT`
-- [`vue-js-modal`](https://github.com/euvl/vue-js-modal) - Modal component by @euvl `MIT`
-- [`v-tooltip`](https://github.com/Akryum/v-tooltip) - Tooltip component by @Akryum `MIT`
-- [`vue-material-tabs`](https://github.com/jairoblatt/vue-material-tabs) - Tab view component by @jairoblatt `MIT`
-- [`VJsoneditor`](https://github.com/yansenlei/VJsoneditor) - Interactive JSON editor component by @yansenlei `MIT`
- - Forked from [`JsonEditor`](https://github.com/josdejong/jsoneditor) by @josdejong `Apache-2.0 License`
-- [`vue-swatches`](https://github.com/saintplay/vue-swatches) - Color palete picker by @saintplay `MIT`
---
diff --git a/docs/developing.md b/docs/developing.md
index 70f009b5..9f3d7a86 100644
--- a/docs/developing.md
+++ b/docs/developing.md
@@ -2,7 +2,7 @@
# Developing
This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.
-If you're adding new features, you may want to check out the [Development Guides](./docs/development-guides.md) docs, for tutorials covering basic tasks.
+If you're adding new features, you may want to check out the [Development Guides](./development-guides.md) docs, for tutorials covering basic tasks.
- [Setting up the Development Environment](#setting-up-the-dev-environment)
- [Prerequisites](#prerequisites)
@@ -83,7 +83,7 @@ You can set variables either in your environment, or using the [`.env`](https://
### Environment Modes
-You can set the environment using the `NODE_ENV` variable. By default, the correct environment should be selected based on the script you run to start the app. The following environments are supported: `production`, `development` and `test`. For more info, see [Vue CLI Environment Modes](https://cli.vuejs.org/guide/mode-and-env.html#modes).
+You can set the environment using the `NODE_ENV` variable. By default, the correct environment should be selected based on the script you run to start the app. The following environments are supported: `production`, `development` and `test`. For more info, see [Vite Env Variables and Modes](https://vite.dev/guide/env-and-mode).
---
@@ -162,7 +162,7 @@ When you submit your PR, include the required info, by filling out the PR templa
New to Web Development? Glad you're here! Dashy is a pretty simple app, so it should make a good candidate for your first PR. Presuming that you already have a basic knowledge of JavaScript, the following articles should point you in the right direction for getting up to speed with the technologies used in this project:
- [Open Source for Beginners](https://opensource.guide/how-to-contribute/)
-- [Introduction to Vue.js](https://v3.vuejs.org/guide/introduction.html)
+- [Introduction to Vue.js](https://vuejs.org/guide/introduction.html)
- [Vue.js Walkthrough](https://www.taniarascia.com/getting-started-with-vue/)
- [ES6 Features](https://github.com/lukehoban/es6features)
- [Definitive guide to SCSS](https://blog.logrocket.com/the-definitive-guide-to-scss/)
@@ -198,7 +198,7 @@ The most significant things to note are:
Styleguides:
-- Vue: [Vue styleguide](https://vuejs.org/v2/style-guide/)
+- Vue: [Vue styleguide](https://vuejs.org/style-guide/)
- JavaScript: [github.com/airbnb/javascript](https://github.com/airbnb/javascript)
---
@@ -213,14 +213,14 @@ Styleguides:
β”œβ”€β”€ src/ # Project front-end source code
β”œβ”€β”€ server.js # A Node.js server to serve up the /dist directory
β”œβ”€β”€ services/ # All server-side endpoints and utilities
-β”œβ”€β”€ vue.config.js # Vue.js configuration
+β”œβ”€β”€ vite.config.mjs # Vite (build tool) configuration
β”œβ”€β”€ Dockerfile # The blueprint for building the Docker container
β”œβ”€β”€ docker-compose.yml # A Docker run command
β”œβ”€β”€ .env # Location for any environmental variables
β”œβ”€β”€ yarn.lock # Auto-generated list of current packages and version numbers
β”œβ”€β”€ docs/ # Markdown documentation
β”œβ”€β”€ README.md # Readme, basic info for getting started
-β”œβ”€β”€ LICENSE.md # License for use
+β”œβ”€β”€ LICENSE # License for use
β•―
```
@@ -327,7 +327,6 @@ Styleguides:
β”‚ β”œβ”€β”€ 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.js # 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
@@ -368,14 +367,5 @@ The easiest method of checking performance is to use Chromium's build in auditin
[BundlePhobia](https://bundlephobia.com/) is a really useful app that lets you analyze the cost of adding any particular dependency to an application
----
-
-## Notes
-
-### Known Warnings
-
-When running the build command, several warnings appear. These are not errors, and do not affect the security or performance of the application. They will be addressed in a future update
-
-`WARN A new version of sass-loader is available. Please upgrade for best experience.` - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration.
`WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB).` - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed.
diff --git a/docs/development-guides.md b/docs/development-guides.md
index 7aa7f3be..55343bb5 100644
--- a/docs/development-guides.md
+++ b/docs/development-guides.md
@@ -262,7 +262,7 @@ If add any new variables, ensure that there is always a fallback (define it in [
If this is your first time working on Dashy, then the [Developing Docs](https://github.com/Lissy93/dashy/blob/master/docs/developing.md) instructions for project setup and running. In short, you just need to clone the project, cd into it, install dependencies (`yarn`) and then start the development server (`yarn dev`).
-To build a widget, you'll also need some basic knowledge of Vue.js. The [official Vue docs](https://vuejs.org/v2/guide/) provides a good starting point, as does [this guide](https://www.taniarascia.com/getting-started-with-vue/) by Tania Rascia
+To build a widget, you'll also need some basic knowledge of Vue.js. The [official Vue docs](https://vuejs.org/guide/) provides a good starting point, as does [this guide](https://www.taniarascia.com/getting-started-with-vue/) by Tania Rascia
If you just want to jump straight in, then [here](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e) is a complete implementation of a new example widget, or take a look at the [`XkcdComic.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/XkcdComic.vue) widget, which is pretty simple.
@@ -278,7 +278,6 @@ Firstly, create a new `.vue` file under [`./src/components/Widgets`](https://git
<script>
-import axios from 'axios';
import WidgetMixin from '@/mixins/WidgetMixin';
import { widgetApiEndpoints } from '@/utils/config/defaults';
@@ -366,9 +365,9 @@ endpoint() {
#### **Making an API Request**
-Axios is used for making data requests, so import it into your component: `import axios from 'axios';`
+The widget mixin gives you a `makeRequest` method for fetching data, so you don't need to import an HTTP client. It handles the loading state, errors, timeouts and the optional CORS proxy for you.
-Under the `methods` block, we'll create a function called `fetchData`, here we can use Axios to make a call to our endpoint.
+Under the `methods` block, we'll create a function called `fetchData`, where we call `makeRequest` with our endpoint (and optionally any headers).
```javascript
fetchData() {
diff --git a/docs/release-workflow.md b/docs/release-workflow.md
index a03edc9c..09d97317 100644
--- a/docs/release-workflow.md
+++ b/docs/release-workflow.md
@@ -45,6 +45,10 @@ Dashy uses a form of semantic versioning ([semver](https://semver.org/)), whereb
<img width="500" src="https://pixelflare.cc/alicia/images/semver.png" />
+### Changelog
+You can view a list of recent changes at [dashy.to/updates](https://dashy.to/updates) or subscribe to the [`rss.xml`](https://dashy.to/rss.xml) feed.
+Likewise, on GitHub you can view all of our [Tags](https://github.com/lissy93/dashy/tags) and [Releases](https://github.com/lissy93/dashy/releases)
+
---
## Workflows
@@ -155,7 +159,6 @@ Mirrors the markdown content from [`/docs`](https://github.com/lissy93/dashy/tre
| **Inputs** | _None_ |
| **Outputs** | Updated docs on the `WEBSITE/docs-site-source` branch |
-
---
## Git Strategy
diff --git a/docs/widgets.md b/docs/widgets.md
index 6f49c405..0a7626c4 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -2261,7 +2261,7 @@ Show user statuses for selected users.
#### Example
```yaml
-- type: nextcloud-userstatus
+- type: nextcloud-user-status
useProxy: true
options:
hostname: https://nextcloud.example.com