Notice: YourDash is under development You can find the current changes on the "dev" branch

YourDash

Links

• Website: https://ydsh.pages.dev or https://yourdash.pages.dev
• Discord: https://discord.gg/aY5CjDZTpG
• GitHub: https://github.com/yourdash-app/yourdash

About

• YourDash's goal is to be a more-performant nextcloud alternative which can achieve a good level of performance on a Raspberry Pi 4.
• Built using Node.js, Vite, Express, Electron, Bun and Typescript

Projects

This repository 'YourDash' is a collection of projects more commonly known as a monorepo

Some of the YourDash projects include

• YourDash Backend (backend)
• YourDash Web (web-client)
• UIKit (uikit)

Host Your Own YourDash Instance

• Docs

Development Setup

Requirements

• Personal IDE / Text Editor of Choice (Webstorm or VSCode is recommended)
  • Webstorm
  • VSCode
• Linting And Formatting
  • ESLint
• Package Manager
  • Yarn (Windows)
  • Bun (Linux)
• Runtimes
  • NodeJS
  • Python 3.11.7
  • Emscripten
    • (Chocolately install method is prefered for windows)
• Version Control
  • Git

Installation and setup (Linux) (Recommended Development Method)

Install Bun and Yarn

curl -fsSL https://bun.sh/install | bash
source ~/.bashrc

npm i -g yarn

Install npm dependencies

bun install

Run YourDash backend in dev mode

bun run yd:dev-backend

Run YourDash web in dev mode

bun run yd:dev-web-client

Installation and setup (Windows)

Install yarn

npm i -g yarn

Install npm dependencies

yarn install

Run YourDash backend in dev mode

yarn run yd:dev-backend

Run YourDash web in dev mode

yarn run yd:dev-web-client

Notes

• Ensure Python 3.11.x is the default for installing yarn packages as 3.11.x+ will cause node-gyp errors during bun install

See more in the docs

https://ydsh.pages.dev/#/docs

Credits

• Created by Ewsgit

Top contributors

TODO: create a GH action to fetch top contributors and edit this list %%top_contributors_list%%