No description
All checks were successful
Build and Push Docker Image / build-and-push (push) Successful in 59s
|
||
---|---|---|
.forgejo/workflows | ||
public | ||
src | ||
.gitignore | ||
biome.json | ||
bun.lock | ||
components.json | ||
docker-compose.yml | ||
Dockerfile | ||
index.html | ||
package.json | ||
README.md | ||
server.ts | ||
tsconfig.app.json | ||
tsconfig.json | ||
tsconfig.node.json | ||
vite.config.ts |
Yumedash
Yumedash is a small, fast dashboard for a homelab. It provides a compact UI to show the status of services and quick links to tools in your home infrastructure.
Data and Icons
-
Data: The dashboard reads its dataset from:
/usr/src/app/public/data.json
Place or edit JSON entries there to change what the dashboard displays.
-
Icons: Place service icons in:
/usr/src/app/public/icons
Filenames must match the icon references used in
data.json
.
Run Locally (Development)
Prerequisites: Bun installed. Default port: 5000
.
-
Install dependencies:
bun install
-
Run the app:
bun run dev
Runs a hot-reloading development server.
Docker Compose
This repository includes a docker-compose.yml
to run Yumedash with Docker Compose.
By default the service is exposed on port 5000
. See docker-compose.yml
for configuration details and any mounts for public/
if you want to supply custom data or icons.
Adding a New Service
- Add or update an entry in
public/data.json
with the service details (label, URL, icon key, etc.). - Add the corresponding SVG/PNG to
public/icons
. - Reload the app to see your changes.