commit ce0dc0880c4bb8ef040bd3ecc5a1de046975763f Author: Space-Banane Date: Wed May 20 20:34:08 2026 +0200 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..9dbecdd --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Jellomator + +Dark, SQLite-backed dashboard for Arr* services and custom links. + +## Features + +- First-run admin setup +- Cookie-based admin auth +- Public dashboard with search/filter +- Link CRUD backed by SQLite +- Icon blobs stored in SQLite +- Single-container deployment + +## Local Dev + +```bash +npm install +npm run dev +``` + +Backend runs on `http://localhost:6363`. + +## Docker + +```bash +docker compose up --build +``` + +The app uses exactly one bind mount: + +`./jellomator.sqlite:/app/data/jellomator.sqlite` + +## SQLite + +All data lives in SQLite, including uploaded icon blobs. There is no separate uploads directory. + +## Gitea CI/CD + +Add these secrets in Gitea: + +- `REGISTRY` +- `REGISTRY_USERNAME` +- `REGISTRY_PASSWORD` +- `IMAGE_NAME` + +The workflow builds and pushes `latest` plus the commit SHA tag.