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!

:octocat: Adds an action to fetch, generate and insert Dashy's sponsors into Credits

Alicia Sykes626c298692fc
diff --git a/.github/workflows/insert-sponsors.yml b/.github/workflows/insert-sponsors.yml
new file mode 100644
index 00000000..bd96dd64
--- /dev/null
+++ b/.github/workflows/insert-sponsors.yml
@@ -0,0 +1,23 @@
+# Generates a list of sponsors, and inserts it into specified files
+# where the `<!-- sponsors --><!-- sponsors -->` tag is
+name: Inserts Current Sponsors in Readme
+on:
+ workflow_dispatch
+ release:
+ types: [published]
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout πŸ›ŽοΈ
+ uses: actions/checkout@v2
+ - name: Generate Sponsors in Readme πŸ’–
+ uses: JamesIves/[email protected]
+ with:
+ token: ${{ secrets.PAT }}
+ file: 'README.md'
+ - name: Generate Sponsors in Credits πŸ’–
+ uses: JamesIves/[email protected]
+ with:
+ token: ${{ secrets.PAT }}
+ file: 'docs/credits.md'
diff --git a/docs/credits.md b/docs/credits.md
index e69de29b..19f76da8 100644
--- a/docs/credits.md
+++ b/docs/credits.md
@@ -0,0 +1,42 @@
+# Credits
+
+## Sponsors
+<!-- sponsors --><!-- sponsors -->
+## Contributors
+
+## Helpful Users
+
+## Dependencies πŸ”—
+
+This app definitely wouldn't have been quite so possible without the making use of the following package and components. Full credit and big kudos to their respective authors, who've done an amazing job in building and maintaining them.
+
+##### Core
+At it's core, the application uses [Vue.js](https://github.com/vuejs/vue), as well as it's services. 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), the config is defined in [YAML](https://github.com/yaml/yaml), and there is a simple [Node.js](https://github.com/nodejs/node) server to serve up the static app.
+
+##### 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`
+- [`vue-i18n`](https://github.com/kazupon/vue-i18n) - Internationalization plugin by @kazupon and community `MIT`
+
+##### 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-toasted`](https://github.com/shakee93/vue-toasted) - Toast notification component by @shakee93 `MIT`
+- [`vue-prism-editor`](https://github.com/koca/vue-prism-editor) - Lightweight code editor by @koca `MIT`
+ - Forked from [`prism.js`](https://github.com/PrismJS/prism) `MIT`
+- [`vue-swatches`](https://github.com/saintplay/vue-swatches) - Color palete picker by @saintplay `MIT`
+
+##### Backup & Sync Server
+Although the app is purely frontend, there is an optional cloud backup and restore feature. This is built as a serverless function on [Cloudflare workers](https://workers.cloudflare.com/) using [KV](https://developers.cloudflare.com/workers/runtime-apis/kv) and [web crypto](https://developers.cloudflare.com/workers/runtime-apis/web-crypto)
+
+##### External Services
+The 1-Click deploy 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/).
+
+---
+
+> This page is auto-generated, using [contribute-list](https://github.com/marketplace/actions/contribute-list) by @akhilmhdh.