Lissy93/dashy
1
1
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2024-12-23 00:41:37 +03:00
Code Issues Packages Projects Releases Wiki Activity
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
391 Commits 24 Branches 47 Tags 953 MiB
Vue 71%
JavaScript 18.3%
SCSS 9.2%
HTML 1.2%
CSS 0.2%
Other 0.1%
036f42ce04
Go to file
Alicia Sykes 036f42ce04 Updates styles
2021-08-29 18:42:34 +01:00
.github :octocat: Adds showcase issue template 2021-06-26 17:03:39 +01:00
docs Adds Changelog, Privacy and License 2021-08-29 18:42:18 +01:00
src Updates styles 2021-08-29 18:42:34 +01:00
static Adds new icons for docs and homepage 2021-08-29 17:30:43 +01:00
.gitignore 🎉 Initialised Dashy Docs Website 2021-06-27 13:47:20 +01:00
babel.config.js 🎉 Initialised Dashy Docs Website 2021-06-27 13:47:20 +01:00
docusaurus.config.js Sets site info and adds logo assets 2021-08-25 23:14:50 +01:00
package.json 🤨 Build banner for homepage. Starting to get my head round Docusourus 2021-06-27 17:58:08 +01:00
sidebars.js 🎉 Initialised Dashy Docs Website 2021-06-27 13:47:20 +01:00
yarn.lock ➖ Removes un-needed dependencies 2021-06-28 21:27:02 +01:00

docs/readme.md

Dashy Docs

Running Dashy

  • Quick Start - TDLR guide on getting Dashy up and running
  • Deployment - Full guide on deploying Dashy either locally or online
  • Configuring - Complete list of all available options in the config file
  • App Management - Managing your app, updating, security, web server configuration, etc
  • Troubleshooting - Common errors and problems, and how to fix them

Development and Contributing

  • Developing - Running Dashy development server locally, and general workflow
  • Development Guides - Common development tasks, to help new contributors
  • Contributing - How you can help keep Dashy alive
  • Showcase - See how others are using Dashy, and share your dashboard
  • Credits - List of people and projects that have made Dashy possible

Feature Docs

  • Authentication - Guide to setting up authentication to protect your dashboard
  • Alternate Views - Outline of available pages / views and item opening methods
  • Backup & Restore - Guide to Dashy's cloud sync feature
  • Icons - Outline of all available icon types for sections and items
  • Language Switching - Details on how to switch language, or add a new locale
  • Status Indicators - Using Dashy to monitor uptime and status of your apps
  • Searching & Shortcuts - Finding and launching your apps, and using keyboard shortcuts
  • Theming - Complete guide to applying, writing and modifying themes and styles

Misc

  • Privacy & Security - List of requests, potential issues, and security resources
  • License - Copy of the MIT License
  • Legal - Licenses of direct dependencies
  • Code of Conduct - Contributor Covenant Code of Conduct
  • Changelog - Details of recent changes, and historical versions