π 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 git clone with https instead of ssh
Alicia Sykes73dd46114fec
diff --git a/README.md b/README.mdindex 5bdc6adb..60e12d37 100644--- a/README.md+++ b/README.md@@ -137,7 +137,7 @@ The image defaults to `:latest`, but you can instead specify a specific version,You will need [git](https://git-scm.com/downloads), the latest or LTS version of [Node.js](https://nodejs.org/) and (optionally) [Yarn](https://yarnpkg.com/) installed on your system.-- Get Code: `git clone [email protected]:Lissy93/dashy.git` and `cd dashy`+- Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`- Configuration: Fill in you're settings in `./public/conf.yml`- Install dependencies: `yarn`- Build: `yarn build`@@ -489,7 +489,6 @@ Huge thanks to the sponsors helping to support Dashy's development!Dashy was made possible thanks to the following packages and components. For more details on each, see [Dependency Credits](./docs/credits.md#dependencies-). Full credit to their respective authors.- Utils: [`crypto-js`](https://github.com/brix/crypto-js), [`axios`](https://github.com/axios/axios), [`ajv`](https://github.com/ajv-validator/ajv)- Components: [`vue-select`](https://github.com/sagalbot/vue-select) by @sagalbot, [`vue-js-modal`](https://github.com/euvl/vue-js-modal) by @euvl, [`v-tooltip`](https://github.com/Akryum/v-tooltip) by @Akryum, [`vue-material-tabs`](https://github.com/jairoblatt/vue-material-tabs) by @jairoblatt, [`JsonEditor`](https://github.com/josdejong/jsoneditor) by @josdejong, [`vue-toasted`](https://github.com/shakee93/vue-toasted) by @shakee93-[`prism.js`](https://github.com/PrismJS/prism)- Core: Vue.js, TypeScript, SCSS, Node.js, ESLint- The backup & sync server uses [Cloudflare workers](https://workers.cloudflare.com/) plus [KV](https://developers.cloudflare.com/workers/runtime-apis/kv) and [web crypto](https://developers.cloudflare.com/workers/runtime-apis/web-crypto)- Services: The 1-Click demo uses [Play-with-Docker Labs](https://play-with-docker.com/). Code is hosted on [GitHub](https://github.com), Docker image is hosted on [DockerHub](https://hub.docker.com/), and the demos are hosted on [Netlify](https://www.netlify.com/).@@ -505,7 +504,7 @@ Dashy was made possible thanks to the following packages and components. For morBefore getting started, you'll need [Git](https://git-scm.com/downloads), [Node](https://nodejs.org/en/download/) and optionally [Yarn](https://yarnpkg.com/) (run `npm i -g yarn`) installed.To set up the development environment:-1. Get Code: `git clone [email protected]:Lissy93/dashy.git` and `cd dashy`+1. Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`2. Install dependencies: `yarn`3. Start dev server: `yarn dev`diff --git a/docs/credits.md b/docs/credits.mdindex 8c8b1c28..7a794d8d 100644--- a/docs/credits.md+++ b/docs/credits.md@@ -22,7 +22,7 @@<!-- readme: sponsors -end -->## Contributors-<!-- readme: contributors -start -->+<!-- readme: contributors, BeginCI/-, deepsourcebot/- -start --><table><tr><td align="center">@@ -90,7 +90,8 @@</a></td></tr></table>-<!-- readme: contributors -end -->+<!-- readme: contributors, BeginCI/-, deepsourcebot/- -end -->+## Helpful Users<!-- readme: EVOTk,shadowking001,turnrye,Robert-Ernst,Niklashere,evroon,MilesTEG1 -start -->diff --git a/docs/deployment.md b/docs/deployment.mdindex d554f8d3..5dfd1e63 100644--- a/docs/deployment.md+++ b/docs/deployment.md@@ -3,14 +3,14 @@Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.#### Quick Start-If you want to skip the fuss, and [get straight down to it](./docs/quick-start.md), then you can spin up a new instance of Dashy by running:+If you want to skip the fuss, and [get straight down to it](/docs/quick-start.md), then you can spin up a new instance of Dashy by running:```docker run -p 8080:80 lissy93/dashy```-See [Management Docs](./docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc+See [Management Docs](/docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc-Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the [configuring docs](./docs/configuring.md).+Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the [configuring docs](/docs/configuring.md).## Deployment Methods@@ -110,7 +110,7 @@ If you are building from source, and would like to use one of the [other DockerfIf you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed, and optionally [yarn](https://yarnpkg.com/)-1. Get Code: `git clone [email protected]:Lissy93/dashy.git` and `cd dashy`+1. Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`2. Configuration: Fill in you're settings in `./public/conf.yml`3. Install dependencies: `yarn`4. Build: `yarn build`diff --git a/docs/developing.md b/docs/developing.mdindex d9f07199..d1249b61 100644--- a/docs/developing.md+++ b/docs/developing.md@@ -18,7 +18,7 @@ You will need either the latest or LTS version of **[Node.js](https://nodejs.org### Running the Project-1. Get Code: `git clone [email protected]:Lissy93/dashy.git`+1. Get Code: `git clone https://github.com/Lissy93/dashy.git`2. Navigate into the directory: `cd dashy`3. Install dependencies: `yarn`4. Start dev server: `yarn dev`@@ -231,7 +231,7 @@ Styleguides:β β βββ Nav.vue # Navigation bar, includes a list of linksβ β β°ββ PageTitle.vue # Page title and sub-title, visible within the Headerβ β°ββ Settings # Components relating to the quick-settings, in the top-right-β βββ AppButtons.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 sizediff --git a/docs/quick-start.md b/docs/quick-start.mdindex b2925a24..ade9a407 100644--- a/docs/quick-start.md+++ b/docs/quick-start.md@@ -104,3 +104,25 @@ For more info, check out the [Documentation](https://github.com/Lissy93/dashy/trEnjoy your dashboard :)---++## Alternative Deployment Method 1 - From Source++You can also easily run the app on your system without Docker. For this [Git](https://git-scm.com/downloads), [Node.js](https://nodejs.org/), and [Yarn](https://yarnpkg.com/) are required.++```+git clone https://github.com/Lissy93/dashy.git && cd dashy+yarn # Install dependencies+yarn build # Build the app+yarn start # Start the app+```+Then edit `./public/conf.yml` and rebuild the app with `yarn build`++---++## Alternative Deployment Method 2 - Netlify++Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many [other cloud providers](./docs/deployment.md#deploy-to-cloud-service)). All you need it a GitHub account.+1. Fork Dashy's repository on GitHub+2. [Log in](app.netlify.com/login/) to Netlify with GitHub+3. Click "New site from Git" and select your forked repo, then click **Deploy**!+4. You can then edit the config in `./public/conf.yml` in your repo, and Netlify will rebuild the app