Update README.md with installation instructions and Docker usage; add docker-compose.yml for service orchestration

This commit is contained in:
Felix Schlusche
2025-10-23 00:57:37 +02:00
parent b4967327a1
commit c8c2a800bb
3 changed files with 86 additions and 23 deletions

View File

@@ -50,12 +50,65 @@ Die Anwendung berechnet automatisch die Pausenzeiten gemäß deutschem Arbeitsze
- `DELETE /api/entries/:id` - Eintrag löschen
- `GET /api/export?from=YYYY-MM-DD&to=YYYY-MM-DD` - Einträge als CSV exportieren
## Lokale Ausführung
## Installation & Ausführung
### Voraussetzungen
### Repository klonen
```bash
git clone https://gitea.fx-se.de/maggot/timetracker.git
cd timetracker
```
### Option 1: Mit Docker Compose (Empfohlen)
**Voraussetzungen:**
- Docker und Docker Compose installiert
**Starten:**
```bash
docker-compose up -d
```
**Logs ansehen:**
```bash
docker-compose logs -f
```
**Stoppen:**
```bash
docker-compose down
```
**Stoppen und Daten löschen:**
```bash
docker-compose down -v
```
Die Anwendung läuft auf:
```
http://localhost:3000
```
### Option 2: Mit Docker (manuell)
**Docker-Image erstellen:**
```bash
docker build -t zeiterfassung .
```
**Container starten:**
```bash
docker run -p 3000:3000 -v $(pwd)/db:/app/db zeiterfassung
```
Das `-v` Flag bindet das Datenbankverzeichnis ein, um Daten zwischen Container-Neustarts zu erhalten.
### Option 3: Lokale Ausführung (ohne Docker)
**Voraussetzungen:**
- Node.js 18+ installiert
### Installation
**Installation:**
1. Abhängigkeiten installieren:
```bash
@@ -72,25 +125,6 @@ npm start
http://localhost:3000
```
## Ausführung mit Docker
### Docker-Image erstellen:
```bash
docker build -t zeiterfassung .
```
### Container starten:
```bash
docker run -p 3000:3000 -v $(pwd)/db:/app/db zeiterfassung
```
Das `-v` Flag bindet das Datenbankverzeichnis ein, um Daten zwischen Container-Neustarts zu erhalten.
### Anwendung aufrufen:
```
http://localhost:3000
```
## CSV-Export-Format
Die exportierte CSV-Datei enthält folgende Spalten: