Skip to content

Software-Engineering-I-HWR/GourmetGuide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧑‍🍳 GourmetGuide

GourmetGuide ist eine Anwendung zur Verwaltung und Darstellung von Kochrezepten. Das Projekt kombiniert eine moderne Weboberfläche mit einer leistungsstarken API und Datenbankintegration, um Benutzern eine einfache und intuitive Plattform für das Erstellen, Teilen und Verwalten von Rezepten zu bieten.

📋 Inhaltsübersicht

✨ Funktionen

  • 🍴 Rezeptverwaltung: Erstellen, Bearbeiten und Löschen von Rezepten.
  • 👤 Benutzerregistrierung und -anmeldung: Authentifizierung mit sicherer Passwortspeicherung.
  • 📄 PDF-Export: Rezepte als PDF herunterladen.
  • 🗄️ Datenbankintegration: Speicherung von Rezepten und Benutzerdaten in einer MariaDB-Datenbank.
  • 📱 Responsive Design: Optimiert für Desktop und mobile Geräte.

🛠️ Technologien

🎨 Frontend

  • React: Benutzeroberfläche
  • TypeScript: Skriptsprache
  • NGINX: Bereitstellung des Frontends

🖥️ Backend

  • Node.js und Express.js: API-Server
  • MariaDB: Datenbank

☁️ Hosting

  • Synology NAS: Hosting der API und Datenbank
  • Docker: Containerisierte Bereitstellung

🌐 Verwendung

  1. 🌍 Aufruf der Webseite:

    • Die Website ist über diese URL erreichbar.
  2. 📋 Registrierung und Anmeldung:

    • Registriere dich als Benutzer.
    • Melde dich an, um Rezepte hinzuzufügen oder zu verwalten.
  3. 🍳 Rezepte erstellen:

    • Fülle das Formular aus, um ein Rezept hinzuzufügen.
    • Rezepte können mit Fotos und Beschreibungen versehen werden.
  4. 📄 PDF-Export:

    • Klicke auf die Schaltfläche „Als PDF speichern“, um ein Rezept herunterzuladen.

🤝 Beitragen

Beiträge sind willkommen! Bitte folge diesen Schritten:

  1. Forke das Repository.
  2. Erstelle einen neuen Branch:
    git checkout -b feature/neue-funktion
  3. Führe deine Änderungen durch und erstelle einen Pull-Request.

📜 Lizenz

Dieses Projekt steht unter der MIT-Lizenz. Weitere Informationen findest du in der Datei LICENSE.

About

Gruppe 5 Software Engineering I

Resources

License

Stars

Watchers

Forks

Contributors 6