From defc0f31613b7ebe7abf25c53dc36de9008c9667 Mon Sep 17 00:00:00 2001 From: Felix Schlusche Date: Fri, 24 Oct 2025 17:29:52 +0200 Subject: [PATCH] docs: update installation instructions for Docker and local setup --- README.md | 71 +++++++++++++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 00f9a06..bfa397e 100644 --- a/README.md +++ b/README.md @@ -166,15 +166,36 @@ Die App implementiert deutsches Arbeitszeitgesetz (ArbZG): ## 🚀 Installation & Ausführung -### 🐳 Option 1: Docker Compose (Empfohlen) +### � Option 1: Vorgefertigtes Docker Image (Empfohlen) -**Voraussetzungen:** Docker & Docker Compose +**Voraussetzungen:** Docker (& Docker Compose optional) ```bash -# Repository klonen -git clone https://gitea.fx-se.de/maggot/timetracker.git -cd timetracker +# Image pullen (public registry, kein Login nötig) +docker pull gitea.fx-se.de/maggot/timetracker:latest +# Container starten +docker run -d \ + -p 3000:3000 \ + -v $(pwd)/db:/app/db \ + --name timetracker \ + gitea.fx-se.de/maggot/timetracker:latest +``` + +**Oder mit docker-compose.yml:** +```yaml +version: '3.8' +services: + app: + image: gitea.fx-se.de/maggot/timetracker:latest + ports: + - "3000:3000" + volumes: + - ./db:/app/db + restart: unless-stopped +``` + +```bash # Starten docker-compose up -d @@ -190,39 +211,13 @@ docker-compose down -v **App läuft auf:** `http://localhost:3000` -### 🐋 Option 2: Vorgefertigtes Docker Image (Gitea Registry) +### 🔨 Option 2: Docker (manuell bauen) ```bash -# Login zur Registry -docker login gitea.fx-se.de +# Repository klonen +git clone https://gitea.fx-se.de/maggot/timetracker.git +cd timetracker -# Image pullen -docker pull gitea.fx-se.de/maggot/timetracker:latest - -# Container starten -docker run -d \ - -p 3000:3000 \ - -v $(pwd)/db:/app/db \ - --name timetracker \ - gitea.fx-se.de/maggot/timetracker:latest -``` - -**docker-compose.yml mit Registry-Image:** -```yaml -version: '3.8' -services: - app: - image: gitea.fx-se.de/maggot/timetracker:latest - ports: - - "3000:3000" - volumes: - - ./db:/app/db - restart: unless-stopped -``` - -### 🔨 Option 3: Docker (manuell bauen) - -```bash # Image bauen docker build -t zeiterfassung . @@ -230,11 +225,15 @@ docker build -t zeiterfassung . docker run -p 3000:3000 -v $(pwd)/db:/app/db zeiterfassung ``` -### 💻 Option 4: Lokal (ohne Docker) +### 💻 Option 3: Lokal (ohne Docker) **Voraussetzungen:** Node.js 18+ ```bash +# Repository klonen +git clone https://gitea.fx-se.de/maggot/timetracker.git +cd timetracker + npm install npm start ```