Skip to content

Programming 3 project by Xudong Zhang, Christian Stehle, Valentin Straßer, Michał Roziel

Notifications You must be signed in to change notification settings

Origin-Masters/Cantine-Planner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

263 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Version Build Status

Xudong Zhang, Christian Stehle, Valentin Straßer, Michał Roziel


1. Projektübersicht

Cantine Planner - Projekt in Programmierung 3

Cantine Planner ist ein Programm, welches zu dem Verwalten von einer Mensa / Kantine dient. Es ermöglicht dem Nutzer, einen Überblick über die aktuell auftretenden Gerichte zu behalten, sowie eine Personalisierung durchzuführen. Eine Datenbank mit bereits existierenden Gerichten wird mitgeliefert.

Weekly Plan

Weekly Plan

Sorting Meals By Calories

Meals By Calories

All Reviews

All Reviews


2. Einige Features

  • Das Programm lässt sich mittels eines TUI Interfaces bedienen.

  • Ein wöchentlicher Speiseplan kann angezeigt werden.

  • User können erstellt werden, hierbei unterscheiden wir zwischen User und Admin.

    • Persönliche Allergene können ausgewählt werden.
    • Lieblingsgericht kann gesetzt werden.
  • Gerichte können hinzugefügt und angezeigt werden.

    • Hierbei wird Preis, Kalorien, Allergene, Fleischinhalt sowie Wochentag gesetzt.
  • Reviews bezüglich Gerichten können verfasst/gelöscht sowie angezeigt werden.

  • Mitgelieferte, bereits gefüllte Datenbank - Man kann direkt anfagen.

  • Heads-up : Du bist an der Reihe die weiteren Funktionalitäten zu erkunden!


3. Systemanforderungen

Java Version : JDK LTS 21
Maven Version : 3.9.9


4. Installation

Das Maven Projekt kann miitels git@github.com:Origin-Masters/Cantine-Planner.git mittels eines Terminals in einen gewählten Ordner runtergeladen werden. Nach dem öffnen des Projekts mit einer IDE Ihrer Wahl geben Sie bitte mvn clean install ein. Dies installiert alle benötigten Dependencies aus der Pom.xml


5. Schnellstart

Das Projekt wird als JAR Datei unter Abgabeversion mittels GitHub Actions mitgeliefert.

Die JAR kann unter https://github.com/Origin-Masters/Cantine-Planner/releases/tag/submission heruntergeladen werden.

Bei Nutzung eines Windows Betriebssystems kann die JAR mittels eines Doppelklicks ausgeführt werden.

Bei Nutzung eines Mac OsX oder Linux Betriebssystems bitten wir Sie die JAR mittels eines Terminals und des Befehls java -jar cantine-planner-Abgabeversion-shaded.jar auszuführen.

Beim Erfolgreichen starten öffnet sich dieses Menü :

Edit 1

6. Anwendungsbeispiele

Die Anwendung kann mittels den Pfeiltasten, dem Tabulator zum wechseln zwischen angezeigten Fenstern sowie der Enter-Taste zur Bestätigung bedient werden. Die Eingabe von Text für die Anwendung erfolgt über die Buchstaben auf der Tastatur. Das Benutzen einer Maus / eines Trackpads ist nicht vorgesehen.

Um Alle Funktionen des Programms Nutzen zu können, kann der Admin-User verwendet werden. Hierbei lauten die Login-Daten wie folgt :

Username : Admin
Password : Admin

Anwendungsbeispiel 1 : Ändern der Daten eines Meals

Edit 1
Edit 3
Edit 2

Anwendungsbeispiel 2 : Hinzufügen eines Reviews

Review 1 Review 2

Legende für unklare Eingaben

  • User-Rollen :

    • 0 : Regulärer Benutzer (Eingeschränkte Nutzung)
    • 1 : Admin Benutzer (Uneingeschränkte Nutzung)
  • Meat-Attribut in Meal :

    • 0 : Meat
    • 1 : Vegetarian
    • 2 : Vegan
  • Meal-Allergene Setzen ( Mittels Komma trennen, "N,G" ):

    • X : None
    • F : Fish
    • N : Nuts
    • G : Gluten
    • M : Milk
    • E : Eggs
    • S : Soy
    • C : Celery
    • T : Mustard
    • U : Sesame
    • L : Lupins
    • P : Peanuts
    • K : Crustaceans
    • I : Sulfites
    • H : Molluscs
    • W : Tree Nuts

7. Bekannte Einschränkungen

Aufgrund einer Fehlerhaften Zeiteinschätung ist es nicht möglich persöhnliche Lieblingsgerichte zu setzen und Email Benachrichtigungen übder dessen auftreten zu erhalten.


About

Programming 3 project by Xudong Zhang, Christian Stehle, Valentin Straßer, Michał Roziel

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages