Letzter Blogbeitrag

[GalacticCodeGambit]

Letzter Blogbeitrag

Aktueller Branche: main

Herzlich willkommen zu unserem letzten Blogbeitrag

Hinweis

Zu einige Dokumente gibt es als Anforderung das mehre Versionen vorhanden sollen.

Aufgrund der Art und Weise, wie wir „Committed“ und „Gemerged“ mit „Squash and Merge“ durchgeführt haben, werden einige Dokumente mit nur einer Version angezeigt, obwohl diese mehrfach überarbeitet bzw. aktualisiert wurden.

Projekt Zusammenfassung

LazyCook ist eine Webanwendung, bei der Nutzer ihre vorhandenen Zutaten eintragen können und darauf basierend automatisch passende Rezepte und Gerichte vorgeschlagen bekommen.
Das Ziel ist es, den Alltag in der Küche zu vereinfachen – ganz nach dem Motto: Was kann ich heute mit dem kochen, was ich gerade da habe?

Star History

Features

• #23 Zutaten hinzufügen können
• #24 Zutaten entfernen können
• #25 Rezepte/Gerichte automatisch vorgeschlagen bekommen auf Grundlage der eingetragenen Zutaten
• #201 Personenzahl hinzufügen können und vorgeschlagene Rezept/Gericht Größe automatisch anpassen
• #27 Als User mit Konto anmelden können
• #26 Als User mit neuem Konto registrieren können

Optionale Features

• KI-basierte Rezeptvorschläge Einbindung
• #33 Alle gespeicherten Zutaten aus der Datenbank, sollen auf einer Seite angezeigt werden und Suchbar sein z.B. nach Gerichtname "Pizza".
• Auf der Zutaten-Seite, werden grundlegende Zutaten wie z.B. Tomaten, Mehl, Salz und Milch automatisch vorgeschlagen. Diese sollen hinzufügbar oder ignorierbar sein.
• #46 Konto löschen/bearbeiten können
• Fehlende Zutaten werden von einem Rezept in einer Einkaufliste aufgelistet
• Der Nutzer kann Rezepte in die Datenbank hinzufügen/erstellen
• #47 Der Nutzer kann bereits hinzugefügte Zutaten bearbeiten, wie z.B. Menge, Einheit
• #45 Passwörter "sicher" in Datenbank Abspeichern als Hash und vom Frontend/Backend "sicher" behandeln

Setup

Anforderungen

• Docker

Installation

1. Kopiere das Repository auf deinen lokalen Rechner:
   
   git clone https://github.com/GalacticCodeGambit/LazyCook.git

2. (Optional) .env-Datei erstellen:
   
   Für die Funktion #115 von Email Versenden/Empfangen muss im Ordner project/ eine .env Datei mit den folgenden Variablen angelegt werden:

   GMAIL_USER=<dein.mail@gmail.com>
   GMAIL_PASSWORD=<dein_gmail_passwort>
   JWT_SECRET_KEY=<ein_langes_zufallssecret>
   

   Hinweis: JWT_SECRET_KEY sollte in produktiven Umgebungen immer gesetzt und einzigartig sein. Für lokale Tests nutzt compose.yaml einen Dev-Default, damit der erste Start nicht abbricht.

3. Navigieren zum Projektverzeichnis:
   
   cd LazyCook/project

4. Starten der Anwendung mit: Docker Compose:
   
   docker compose up --build -d

Die Anwendung sollte jetzt unter http://localhost:8000 erreichbar sein.

Verwendete Technologien

• Frontend: HTML, CSS, TypeScript/React
• Backend: Python
• DB: SQLite
• Tests: Pytest
• CI/CD: GitHub Actions
• Linting: Super-Linter
• Metriken Analyse: SonarQube Cloud
• Containerization: Docker
• Projekt Management: GitHub Projects

Index der Dokumentation

• Code-Repository

• Scrum-Board

• Projekt-Handout

• Testbericht

• SRS

• Softwarearchitektur

• CI/CD-Setup im Überblick

• RMMM-Liste

• Projekt-Retrospektive und das zugehörige Memo (als Blog16)

• Review-Protokoll-01

• SonarQube Cloud

• ADR:

  • ADR01
  • ADR02
  • ADR03
  • ADR04
  • ADR05

• Qualitätsbaum.md (überarbeitet), Qualitätsbaum.pnd (alt)

• Qualitätsszenario.md (überarbeitet), Qualitätsszenario.png (alt)

• Mockups: Webseite

  • Abmelde_Screen
  • Anmelde_Screen
  • Impressum
  • Registrieren
  • Rezepte_Anzeige
  • Startseite
  • Zutateneingabe
  • Zutateneingabe_Tomate

• Statistiken von GitHub Project:

  • Burn-up.png
  • Discipline-Time-per-Sprint.png
  • Milestone-Time-Per-Sprint.png
  • Status.png
  • Time.png
  • Timechart-Discipline-and-Phase.png

• Code Refaktorisierung:

  • Zusammenfassung der Refaktorisierung
  • Refactoring-Bericht: Schichtenarchitektur & SRP

• SonarQube Full Metrics Report

• Klassen Diagramm

• UML

  • UML-Aktivitaetsdiagramm_Anmelden.png
  • UML-Aktivitaetsdiagramm_Rezept-filtern.png
  • UML-Sequenzdiagramm_Rezepte-filtern.drawio.png
  • UML-Sequenzdiagramm_Zutaten-Eintragen.png
  • UML-Sequenzdiagramm_automatischer-Rezeptvorschlag.png
  • UML_Aktivitaetsdiagramm_Registrieren.png
  • UML_Anwendungsdiagramm_v2.jpg
  • UML_Anwendungsdiagramm_v2_Status_10122025.jpg