mirror of
https://github.com/Dvorinka/Dash.git
synced 2026-10-28 15:51:27 +00:00
Establishes the skeleton every later phase builds on: Go+Gin API with zap logging, /api/healthz, SQLite+goose runner; Vite+React18+TS strict+ Tailwind v4 frontend with bento-mono theme tokens; openapi.yaml driving a generated TS client; oxlint with vendored anti-slop rules; GitHub CI; multi-stage Dockerfile -> 33.6MB distroless image; docker compose up serves the blank board. Generated with [Devin](https://devin.ai) Authored By: TDvorak <[email protected]> Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
47 lines
883 B
Markdown
47 lines
883 B
Markdown
# Dash
|
|
|
|
A self-hosted homelab dashboard. CasaOS-grade ease of use, Vercel-grade design.
|
|
Single container, UI-managed, no YAML, no auth.
|
|
|
|
**Status:** pre-release. See [ROADMAP.md](ROADMAP.md).
|
|
|
|
## Run
|
|
|
|
```sh
|
|
docker run -v ./data:/data -p 3000:3000 dash
|
|
```
|
|
|
|
or
|
|
|
|
```sh
|
|
docker compose up
|
|
```
|
|
|
|
Then open http://localhost:3000.
|
|
|
|
## Develop
|
|
|
|
Requires Go 1.24+ and Node 20+.
|
|
|
|
```sh
|
|
npm install # workspaces: frontend + api-client
|
|
npm run generate # regenerate TS client from openapi.yaml
|
|
npm run dev # vite dev on :5173, proxies /api to :8080
|
|
```
|
|
|
|
In another shell:
|
|
|
|
```sh
|
|
cd apps/backend
|
|
DASH_DEV=1 go run ./cmd/dash # API on :8080 (DASH_DEV skips embedded UI)
|
|
```
|
|
|
|
## Stack
|
|
|
|
Go + Gin + SQLite (single static binary, embeds the frontend) · React 18 +
|
|
Vite + TS strict + Tailwind + shadcn/ui + dnd-kit · OpenAPI-generated client.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|