Installation

Voraussetzungen

• Stelle sicher, dass Docker und Docker Compose auf deinem System installiert sind:
  • macOS: Du kannst Docker Desktop installieren. Es enthält Docker Compose.
  • Windows: Installiere ebenfalls Docker Desktop. Aktiviere bei Bedarf die “WSL 2”-Integration.
  • Linux: Installiere Docker und Docker Compose mit deinen Paketmanagern (Installationsanleitung).

Kommandos

1. Projekt-Container starten

   docker-compose up
   

   Dieses Kommando lädt alle benötigten Images, erstellt Container und startet die Services. Die Logs der Container werden direkt im Terminal angezeigt.

2. Im Hintergrund starten (detached mode) Falls du die Logs nicht sehen möchtest, kannst du die Services im Hintergrund starten:

   docker-compose up -d
   

3. Container und Services stoppen Um alle laufenden Container und Services zu stoppen, benutze:

   docker-compose down
   

4. Abhängigkeiten nach Änderungen erneut bauen Wenn du Änderungen an Dockerfiles oder Konfigurationen vorgenommen hast, kannst du die Container neu bauen:

   docker-compose up --build
   

---

Tipps zur Fehlersuche

• Container-Logs ansehen Falls ein Dienst nicht wie gewünscht funktioniert, kannst du seine Logs mit folgendem Befehl prüfen:

  docker-compose logs <service-name>
  

  Ersetze <service-name> durch den Namen des betroffenen Containers (siehe docker-compose.yml).

• Container debuggen Um in einen laufenden Container zu wechseln und ihn zu debuggen, benutze:

  docker exec -it <container-name> /bin/bash
  

  Ersetze <container-name> durch den Namen des Containers.

API Endpoints

Users

• POST /users/login

  • Beschreibung: Loginfunktion für den Benutzer.

  • Body-Parameter:

    • username (string) Der Name des Benutzers.
    • password (string:sha256) Das Passwort für den Benutzer.

  • POST /users/register

    • Beschreibung: Registriert einen neuen Benutzer
      • Body-Parameter:
        • fullname (string) Name des Benutzers
        • email (string) Email des Benutzers
        • address (string) Wohnort des Benutzers
        • birthdate (datum) Geburtstag des Benutzers
        • phonenumber (string) Telefonnummer des Benutzers
        • login_name (string) login name des Benutzers
        • password (string:sha256) password des Benutzers

---

Content

• POST /content/upload
  • Beschreibung: Lädt einen neuen Inhalt hoch.
  • Header:
    • token (string) JWT token des Benutzers
  • Body-Parameter:
    • image (string:base64) das hochzuladende Bild