mirror of https://github.com/lissy93/dashy
41 lines
35 KiB
HTML
41 lines
35 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-beta.2">
|
|
<link rel="search" type="application/opensearchdescription+xml" title="Dashy" href="/opensearch.xml">
|
|
<script src="https://no-track.as93.net/js/script.js" defer="defer" data-domain="dashy.to"></script><title data-react-helmet="true">Contributing | Dashy</title><meta data-react-helmet="true" property="og:url" content="https://dashy.to/docs/contributing"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Contributing | Dashy"><meta data-react-helmet="true" name="description" content="First off, thank you for considering contributing towards Dashy! 🙌"><meta data-react-helmet="true" property="og:description" content="First off, thank you for considering contributing towards Dashy! 🙌"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://dashy.to/docs/contributing"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.de060916.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.ac7349e8.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.d13b237a.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
|
|
<div><a href="#main" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Dashy</b></a><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Live Demo</a><a class="navbar__item navbar__link" href="/docs/quick-start">Quick Start</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Documentation</a></div><div class="navbar__items navbar__items--right"><div class="react-toggle displayOnlyInLargeViewport_cxYs react-toggle--checked react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌙</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">☀️</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" checked="" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li><li class="menu__list-item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="menu__link">Live Demo</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/quick-start">Quick Start</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs">Documentation</a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><aside class="docSidebarContainer_0YBq"><div class="sidebar_LIo8"><nav class="menu menu--responsive thin-scrollbar menu_oAhv menuWithAnnouncementBar_IVfW" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_nrF-" width="24" height="24" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Running Dashy</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/quick-start">Quick Start</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/deployment">Deployment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/configuring">Configuring</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/management">App Management</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/troubleshooting">Troubleshooting</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Feature Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/icons">Icons</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/widgets">Widgets</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/theming">Theming</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/status-indicators">Status Indicators</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/authentication">Authentication</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/searching">Keyboard Shortcuts</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/alternate-views">Alternate Views & Opening Methods</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/multi-language-support">Internationalization</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/backup-restore">Cloud Backup and Restore</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/pages-and-sections">Pages and Sections</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Community</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/showcase">*Dashy Showcase* 🌟</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/contributing">Contributing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/developing">Developing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/development-guides">Development Guides</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Misc</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/privacy">Privacy & Security</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/changelog">Changelog</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/license">license</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/code-of-conduct">Contributor Covenant Code of Conduct</a></li></ul></li></ul></nav><div class="sidebar-ad"><script async="" src="//cdn.carbonads.com/carbon.js?serve=CWYIC53L&placement=dashyto" id="_carbonads_js"></script></div></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="docItemContainer_oiyr"><article><div class="markdown"><header><h1 class="h1Heading_dC7a">Contributing</h1></header><p>First off, thank you for considering contributing towards Dashy! 🙌
|
|
There are several ways that you can help out, and any contributions, however small will always be very much appreciated.
|
|
You will be appropriately credited in the readme - huge thank you to <a href="/docs/credits">everyone who has helped</a> so far 💞</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="take-a-2-minute-survey"></a>Take a 2-minute survey<a class="hash-link" href="#take-a-2-minute-survey" title="Direct link to heading">#</a></h2><p>Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)</p><p><a href="https://survey.typeform.com/to/gl0L68ou" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy" alt="Take the Survey"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="share-your-dashboard"></a>Share your dashboard<a class="hash-link" href="#share-your-dashboard" title="Direct link to heading">#</a></h2><p>Dashy now has a <a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-" target="_blank" rel="noopener noreferrer">Showcase</a> where you can show off a screenshot of your dashboard, and get inspiration from other users (and I really love seeing how people are using Dashy). To <a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard" target="_blank" rel="noopener noreferrer">submit your dashboard</a>, either open a PR or raise an issue.</p><p><a href="https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%92%AF+Showcase&template=showcase-addition.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Add_your_Dashboard-Showcase-%238616ee?style=for-the-badge&logo=feathub&logoColor=8616ee" alt="Add your Dashboard to the Showcase"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="make-a-small-donation"></a>Make a small donation<a class="hash-link" href="#make-a-small-donation" title="Direct link to heading">#</a></h2><p>Donations help to cover server costs, development time and caffeine ;)
|
|
Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.</p><p><a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda" alt="Sponsor Lissy93 on GitHub"></a></p><p>Sponsoring will give you several perks - for $1 / £0.75 per month, you'll get a sponsor badge on your profile, be credited on the Dashy's readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see <a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer">@Lissy93's Sponsor Page</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="enable-anonymous-bug-reports"></a>Enable Anonymous Bug Reports<a class="hash-link" href="#enable-anonymous-bug-reports" title="Direct link to heading">#</a></h2><p>Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. <a href="https://github.com/getsentry/sentry" target="_blank" rel="noopener noreferrer">Sentry</a> is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it).</p><p>To enable error reporting:</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI yaml"><pre tabindex="0" class="prism-code language-yaml codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token key atrule">appConfig</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">enableErrorReporting</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token boolean important">true</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>All reporting is <strong>disabled</strong> by default, and no data will ever be sent to any external endpoint without your explicit consent. All statistics are anonymized and stored securely. For more about privacy and security, see the <a href="https://sentry.io/security/" target="_blank" rel="noopener noreferrer">Sentry Security Docs</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="add-translations"></a>Add Translations<a class="hash-link" href="#add-translations" title="Direct link to heading">#</a></h2><p>If you speak another language, then adding translations will help make Dashy available to non-native English speakers. This is a very quick and easy task, as all application text is located in <a href="https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json" target="_blank" rel="noopener noreferrer"><code>locales/en.json</code></a>, so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the <a href="https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md" target="_blank" rel="noopener noreferrer">Multi-Language Support Docs</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="submit-a-pr"></a>Submit a PR<a class="hash-link" href="#submit-a-pr" title="Direct link to heading">#</a></h2><p>Contributing to the code or docs is super helpful. You can fix a bug, add a new feature or improve an existing one. If you've built your own custom widget, theme or view, consider sharing it in a PR. I've written <a href="/docs/development-guides">several guides</a> to help you get started, and the steps for setting up the development environment are outlined in the <a href="/docs/developing">Development Docs</a>. Feel free to ask if you have any questions.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="improve-the-docs"></a>Improve the Docs<a class="hash-link" href="#improve-the-docs" title="Direct link to heading">#</a></h2><p>Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
|
|
All content is located either in the <a href="/README"><code>./README.md</code></a> or <a href="/docs"><code>/docs/</code></a> directory, and synced to the Wiki and website using a GH <a href="/actions/workflows/wiki-sync.yml">action</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="raise-a-bug"></a>Raise a bug<a class="hash-link" href="#raise-a-bug" title="Direct link to heading">#</a></h2><p>If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.</p><p><a href="https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot" alt="Raise a Bug"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="join-the-discussion"></a>Join the discussion<a class="hash-link" href="#join-the-discussion" title="Direct link to heading">#</a></h2><p>I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users.</p><p><a href="https://github.com/Lissy93/dashy/discussions" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat" alt="Join the Discussion on GitHub"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-a-feature-via-bountysource"></a>Request a feature via BountySource<a class="hash-link" href="#request-a-feature-via-bountysource" title="Direct link to heading">#</a></h2><p>BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.</p><p><a href="https://www.bountysource.com/teams/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty" alt="Request a Feature on BountySource"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="spread-the-word"></a>Spread the word<a class="hash-link" href="#spread-the-word" title="Direct link to heading">#</a></h2><p>Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms.</p><p><a href="https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon" alt="Share Dashy on Mastodon"></a>
|
|
<a href="http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit" alt="Share Dashy on Reddit"></a>
|
|
<a href="https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter" alt="Share Dashy on Twitter"></a>
|
|
<a href="https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook" alt="Share Dashy on Facebook"></a>
|
|
<a href="https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin" alt="Share Dashy on LinkedIn"></a>
|
|
<a href="https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest" alt="Share Dashy on Pinterest"></a>
|
|
<a href="https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk" alt="Share Dashy on VK"></a>
|
|
<a href="viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber" alt="Share Dashy via Viber"></a>
|
|
<a href="https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram" alt="Share Dashy via Telegram"></a>
|
|
<a href="mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail" alt="Share Dashy via Email"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="star-upvote-or-leave-a-review"></a>Star, Upvote or Leave a Review<a class="hash-link" href="#star-upvote-or-leave-a-review" title="Direct link to heading">#</a></h2><p>Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users discover Dashy</p><p><a href="https://www.producthunt.com/posts/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt" alt="ProductHunt"></a>
|
|
<a href="https://alternativeto.net/software/dashy/about/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=flat-square&logo=abletonlive" alt="AlternativeTo"></a>
|
|
<a href="https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-Slant-%2346a1df?style=flat-square&logo=capacitor" alt="Slant"></a>
|
|
<a href="https://github.com/Lissy93/dashy/stargazers" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square" alt="Star on GitHub"></a>
|
|
<a href="https://hub.docker.com/r/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square" alt="Star on DockerHub"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="follow-for-more"></a>Follow for More<a class="hash-link" href="#follow-for-more" title="Direct link to heading">#</a></h2><p>If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.</p><p><a href="https://twitter.com/Lissy_Sykes" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter" alt="Alicia Sykes on Twitter"></a>
|
|
<a href="https://github.com/Lissy93" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social" alt="Alicia Sykes on GitHub"></a>
|
|
<a href="https://mastodon.social/web/accounts/1032965" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social" alt="Alicia Sykes on Mastodon"></a>
|
|
<a href="https://keybase.io/aliciasykes" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase" alt="Alicia Sykes on Keybase"></a>
|
|
<a href="https://aliciasykes.com" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ" alt="Alicia Sykes's Website"></a>
|
|
<a href="https://notes.aliciasykes.com/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog" alt="Alicia Sykes's Blog"></a>
|
|
<a href="https://keybase.io/aliciasykes/pgp_keys.asc" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt" alt="Alicia Sykes's PGP"></a></p><p>If you like, you could also consider <a href="https://notes.aliciasykes.com/subscribe" target="_blank" rel="noopener noreferrer">subscribing to my mailing list</a> for occasional blog post updates.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="contributors"></a>Contributors<a class="hash-link" href="#contributors" title="Direct link to heading">#</a></h3><p>For a full list of Dashy's contributors, see the <a href="/docs/credits">Credits Page</a></p><p><a href="https://github.com/Lissy93/dashy/blob/master/docs/credits.md" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg" alt="Auto-generated contributors"></a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="star-gazers-over-time"></a>Star-Gazers Over Time<a class="hash-link" href="#star-gazers-over-time" title="Direct link to heading">#</a></h3><p><a href="https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy" target="_blank" rel="noopener noreferrer"><img src="https://starchart.cc/Lissy93/dashy.svg" alt="Stargazers"></a></p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/showcase"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« *Dashy Showcase* 🌟</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/developing"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Developing »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#take-a-2-minute-survey" class="table-of-contents__link">Take a 2-minute survey</a></li><li><a href="#share-your-dashboard" class="table-of-contents__link">Share your dashboard</a></li><li><a href="#make-a-small-donation" class="table-of-contents__link">Make a small donation</a></li><li><a href="#enable-anonymous-bug-reports" class="table-of-contents__link">Enable Anonymous Bug Reports</a></li><li><a href="#add-translations" class="table-of-contents__link">Add Translations</a></li><li><a href="#submit-a-pr" class="table-of-contents__link">Submit a PR</a></li><li><a href="#improve-the-docs" class="table-of-contents__link">Improve the Docs</a></li><li><a href="#raise-a-bug" class="table-of-contents__link">Raise a bug</a></li><li><a href="#join-the-discussion" class="table-of-contents__link">Join the discussion</a></li><li><a href="#request-a-feature-via-bountysource" class="table-of-contents__link">Request a feature via BountySource</a></li><li><a href="#spread-the-word" class="table-of-contents__link">Spread the word</a></li><li><a href="#star-upvote-or-leave-a-review" class="table-of-contents__link">Star, Upvote or Leave a Review</a></li><li><a href="#follow-for-more" class="table-of-contents__link">Follow for More</a><ul><li><a href="#contributors" class="table-of-contents__link">Contributors</a></li><li><a href="#star-gazers-over-time" class="table-of-contents__link">Star-Gazers Over Time</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Intro</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="footer__link-item">Live Demo</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quick-start">Quick Start</a></li><li class="footer__item"><a class="footer__link-item" href="/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Setup Guide</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/deployment">Deploying</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuring">Configuring</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/management">Management</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Feature Docs Pt 1</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/authentication">Authentication</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/alternate-views">Alternate Views</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/backup-restore">Backup & Restore</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/icons">Icons</a></li></ul></div><div class="col footer__col"><div class="footer__title">Feature Docs Pt 2</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/multi-language-support">Language Switching</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/status-indicators">Status Indicators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/searching">Searching & Shortcuts</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/theming">Theming</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/developing">Developing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/development-guides">Development Guides</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/showcase">Showcase</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/credits">Credits</a></li></ul></div><div class="col footer__col"><div class="footer__title">Misc</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/privacy">Privacy & Security</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/license">License</a></li><li class="footer__item"><a href="https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Legal</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/code-of-conduct">Code of Conduct</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/changelog">Changelog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><a href="https://dashy.to">Dashy</a> - The Self-Hosted Dashboard for your Homelab<br>License under <a href="https://github.com/Lissy93/dashy/blob/master/LICENSE">MIT</a>. Copyright © 2024 <a href="https://aliciasykes.com">Alicia Sykes</a></div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.ac7349e8.js"></script>
|
|
<script src="/assets/js/main.d13b237a.js"></script>
|
|
</body>
|
|
</html> |