2b1b28fdfe
Holt den neuesten Stand aus Git und baut die Container neu. Findet seinen eigenen Pfad (von ueberall aufrufbar), nutzt die vorhandene deploy/.env, erkennt docker compose v1/v2 und prueft am Ende /api/health. Optionen: --prune (alte Images aufraeumen), --no-pull (nur neu bauen). Bei fehlgeschlagenem git pull gibt es einen Hinweis auf lokale Aenderungen. Im Repo direkt als ausfuehrbar markiert; README ergaenzt. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
112 lines
4.0 KiB
Markdown
112 lines
4.0 KiB
Markdown
# 🥫 Project-Good – Selfhostbare Lebensmittel-Lagerverwaltung
|
||
|
||
Ein selbst gehosteter Dienst zur Verwaltung deines Lebensmittelvorrats:
|
||
Ein-/Auslagern per Barcode, MHD-/Ablaufverwaltung mit Chargen, Mindestbestände,
|
||
automatische Einkaufsliste – mit **Web-UI** und (in Vorbereitung) **nativer iOS-App**.
|
||
|
||
> Dies ist **Schritt 1** (Fundament). Der komplette Fahrplan steht in
|
||
> [docs/ROADMAP.md](docs/ROADMAP.md).
|
||
|
||
## Features (Schritt 1)
|
||
- **Barcode-Lookup** über [Open Food Facts](https://world.openfoodfacts.org) mit
|
||
lokalem Fallback (unbekannte Produkte selbst anlegen).
|
||
- **Chargen mit MHD:** Jedes Einlagern erzeugt eine Charge mit eigenem
|
||
Mindesthaltbarkeitsdatum. Beim Auslagern wird automatisch die zuerst ablaufende
|
||
Charge zuerst entnommen (**FEFO** – First Expired, First Out).
|
||
- **Einheiten:** Basiseinheit Stück / Gramm / Milliliter plus optionale
|
||
Packungsgröße → Ein-/Auslagern in Packungen **oder** Teilmengen (z. B. 200 g).
|
||
- **Mindestbestände** pro Produkt → automatische **Einkaufsliste**.
|
||
- **Ablaufwarnung** für bald ablaufende Chargen (Frist konfigurierbar).
|
||
- **Lagerorte** (flach; Unterlagerorte folgen in Schritt 3).
|
||
- **Mehrbenutzer mit Rollen:**
|
||
- **Admin** – verwaltet Produkte, Lagerorte, Benutzer, Mindestbestände.
|
||
- **Nutzer** – nur ein-/auslagern und ansehen.
|
||
- Bewegungen werden protokolliert (wer hat wann was ein-/ausgelagert).
|
||
|
||
## Architektur
|
||
| Teil | Technik |
|
||
|---------|--------------------------------------|
|
||
| Backend | Python · FastAPI · SQLAlchemy |
|
||
| DB | PostgreSQL |
|
||
| Web-UI | React · Vite (via nginx ausgeliefert)|
|
||
| iOS | SwiftUI (Schritt 2) |
|
||
| Deploy | Docker Compose · `install.sh` |
|
||
|
||
```
|
||
backend/ FastAPI-App + Tests
|
||
web/ React/Vite SPA
|
||
deploy/ docker-compose.yml, install.sh, .env.example
|
||
docs/ Roadmap
|
||
```
|
||
|
||
## Installation (selfhosted, Linux)
|
||
Voraussetzung: eine Linux-Maschine (Server, NAS, Raspberry Pi …). Docker wird bei
|
||
Bedarf automatisch installiert.
|
||
|
||
```bash
|
||
git clone https://git.scarriffle.com/Scarriffle/project-good.git
|
||
cd project-good/deploy
|
||
chmod +x install.sh
|
||
./install.sh # interaktiv – fragt Port & Admin-Passwort
|
||
# oder vollautomatisch mit generiertem Admin-Passwort:
|
||
# ./install.sh --yes
|
||
```
|
||
|
||
> Ist das Gitea-Repo privat, fragt `git clone` nach Benutzername + Access-Token.
|
||
> Falls `git` fehlt: `apt update && apt install -y git`.
|
||
|
||
Nach dem Start:
|
||
- Web-UI: `http://<server-ip>:8080` (Port konfigurierbar)
|
||
- Anmeldung mit dem im Installer angezeigten Admin-Benutzer/Passwort.
|
||
|
||
## Aktualisieren
|
||
```bash
|
||
cd project-good/deploy
|
||
./update.sh # holt den neuesten Stand aus Git und baut neu
|
||
./update.sh --prune # zusätzlich alte Images aufräumen
|
||
./update.sh --no-pull # nur neu bauen, ohne git pull
|
||
```
|
||
Das Skript ist von überall aufrufbar, nutzt die vorhandene `deploy/.env` und
|
||
prüft am Ende, ob das Backend wieder erreichbar ist.
|
||
|
||
Verwaltung:
|
||
```bash
|
||
cd deploy
|
||
docker compose logs -f # Logs ansehen
|
||
docker compose down # stoppen
|
||
docker compose up -d # starten
|
||
```
|
||
|
||
Die Konfiguration liegt in `deploy/.env` (Passwörter, Port, JWT-Secret). Für den
|
||
Produktivbetrieb bitte hinter einen HTTPS-Reverse-Proxy (z. B. Caddy/Traefik) stellen.
|
||
|
||
## Entwicklung (ohne Docker)
|
||
**Backend:**
|
||
```bash
|
||
cd backend
|
||
python -m venv .venv && source .venv/bin/activate
|
||
pip install -r requirements.txt
|
||
# lokale SQLite-DB nutzen:
|
||
export DATABASE_URL="sqlite:///./project_good.db"
|
||
uvicorn app.main:app --reload
|
||
```
|
||
API-Doku dann unter `http://localhost:8000/docs`.
|
||
|
||
**Web:**
|
||
```bash
|
||
cd web
|
||
npm install
|
||
npm run dev # http://localhost:5173, proxyt /api → localhost:8000
|
||
```
|
||
|
||
**Tests:**
|
||
```bash
|
||
cd backend
|
||
pip install -r requirements.txt
|
||
pytest # prüft FEFO-Abbuchung und Einheiten-Umrechnung
|
||
```
|
||
|
||
## Nächste Schritte
|
||
Native iOS-App (Schritt 2) und fortgeschrittene Features (Gruppen-Intelligenz,
|
||
Unterlagerorte, Push-Benachrichtigungen …) – siehe [docs/ROADMAP.md](docs/ROADMAP.md).
|