diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 47e5e8f..d5b1b3d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,6 +25,9 @@ build_frontend: - ssh $DEPLOY_ENV_USER@$DEPLOY_ENV_TARGET "rm -rf /home/$DEPLOY_ENV_USER/serve/*" - ssh $DEPLOY_ENV_USER@$DEPLOY_ENV_TARGET "mkdir -p /home/$DEPLOY_ENV_USER/serve/$CI_COMMIT_REF_NAME" - rsync --progress -av -e ssh /workdir/build/* $DEPLOY_ENV_USER@$DEPLOY_ENV_TARGET:/home/$DEPLOY_ENV_USER/serve/ + only: + changes: + - Frontend/* environment: name: deploy url: https://$DEPLOY_ENV_TARGET diff --git a/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md b/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md index ef9d281..8cb0c2b 100644 --- a/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md +++ b/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md @@ -1,34 +1,57 @@ # Endpoints -## Screens +Im folgenden werden diverse Http-Schnittstellen zur Kommunikation zwischen Frontend und Backend beschrieben. + +Zusäzlich ist angegeben, für welche Benutzerrollen die jeweiligen Funktionen zu Verfügung steht. + +--- + ### Login -- POST Login -- Parameter +- POST login + - Parameter - Username string - Password string +- POST logout ### Übersichtsseite (Dozent und Verwaltung) - GET screens -- Liefert alle erlaubten Ansichten für einen User zurück + - Liefert alle erlaubten Ansichten für einen User zurück + - Liefert Array + - Screen string ### Wochenübersicht (Dozent) - GET weekly_overview -- Liefert alle Unterrichtseinheiten für die nächsten 7 Tage + - Liefert alle Unterrichtseinheiten für die nächsten 7 Tage + - Liefert Array ### Kursübericht [besser Kursdetails] (Dozent und Verwaltung) - GET course_detail + - Liefert alle Informationen zu einem Kurs + - Paramter + - KursID string + - Liefert object - KursID string + - DozentID string + - DozentName string + - Unterrichtseinheiten Array + - StartZeit DateTime + - Students Array + - StudentID string + - StudentName string - GET course_contents + - Liefert alle eingetragenen Inhalten zum Kurs + - Parameter - KursID string - PUT new_course_content -- Inhalt der Letzten UE wird gesetzt + - Inhalt der letzten UE wird gesetzt + - Parameter - KursID string - - content string + - Content string ### Welcher Lehrer Welcher Kurs (Verwaltung) - GET course_teacher_match -- Liefert Array + - Liefert Array - KursID string - KursName string - DozentID string @@ -36,7 +59,7 @@ ### Welche Schüler Welcher Kurs (Verwaltung) - GET course_student_match -- Liefert Array + - Liefert Array - KursID string - KursName string - DozentID string @@ -44,75 +67,82 @@ ### Lehrerübersicht (Verwaltung) - GET all_teachers -- Liefert Array + - Liefert alle Dozenten + - Liefert Array - DozentID string - DozentName string ### Schüler von Lehrer (Dozent und Verwaltung) - GET students_of_teacher -- Parameter DozentID -- Liefert Array + - Parameter DozentID + - Liefert Array - StundentID string - StudentName string ### Raumübersicht (Verwaltung) - GET rooms -- Liefert Array + - Liefert alle verfügbaren Räume, inkl. der vorhandenen Instrumente + - Liefert Array - RaumID string - RaumName string - Instrumente Array - - InstrumentName string -- GET instruments -- Liefert Array - - InstrumentName string + - InstrumentID string + - InstrumentName string - PUT create_rooms + - Parameter - RaumName string - Instrumente Array + - InstrumentID string - ### Raumdetails (Verwaltung) - GET room_free -- Parameter RaumID -- Liefert Frei bool + - Liefert alle aktuell freien Räumen + - Parameter + - RaumID string + - Liefert object + - Belegt bool - GET room_instruments -- Parameter RaumID -- Liefert Array + - Liefert alle Instrumente zu einem Raum + - Parameter + - RaumID string + - Liefert Array + - InstrumentID string - InstrumentName string - Vorhanden bool - GET lessons -- Parameter + - Liefert alle Unterrichtszeiten in einem Raum + - Parameter - RaumID string - - Sort // Maybe wenn benötigt -- Liefert Array - - StartZeit DT - + - Liefert Array + - StartZeit DateTime -### Kurs Erstellen [Person + Kurs] -- nutzt GET instruments -- GET create_ +### Kurs Erstellen [Person + Kurs] (Verwaltung) - POST get_capable_teachers -- Parameter + - Liefert alle Dozenten, die einen bestimmten Kurs leiten können + - Parameter - Typ string - Instrumente Array -- Liefert Array + - InstrumentID string + - Liefert Array - DozentID string - DozentName string - POST get_cross_referenced_rooms -- Parameter + - Parameter - Typ string - Instrumente Array - - InstrumentName string + - InstrumentID string - DozentID string -- Liefert Array + - Liefert Array - RaumID string - Zeiten Array - - Zeitfenster number + - Zeit DateTime - POST create_person -- Parameter + - Erstellt eine Person + - Parameter - Name string - Vorname string - - istErmaesigt bool - - Geburtsdatum DT + - IstErmaessigt bool + - Geburtsdatum DateTime - Geburtsort string - PLZ string - Ort string @@ -120,16 +150,44 @@ - Bankname string - BLZ string - KontoNr string + - Liefert object + - StudentID string - POST create_course -- Parameter - // Kursdaten + - Erstellt einen Kurs + - Parameter - Typ string - Instrumente Array - - Instrument string + - InstrumentID string - DonzentID string - Unterrichtseinheiten Array - - Zeit int + - Zeit int - POST enroll_student -- Parameter + - Ordnet einen Schueler einem Kurs zu + - Parameter - KursID string - - PersonID string + - StudentID string + +### Aufnahmeantrag (Anonymous) +- POST aufnahmeantrag + - Parameter + - Name string + - Vorname string + - IstErmaessigt bool + - Geburtsdatum DateTime + - Geburtsort string + - PLZ string + - Ort string + - StrasseHNR string + - Bankname string + - BLZ string + - KontoNr string + - Typ string + - Instrumente Array + - InstrumentID string + - Laufzeit + - KursID string + ### Instrumente (Anonymous) +- GET instruments + - Liefert Instrumente Array + - InstrumentID string + - InstrumentName string \ No newline at end of file diff --git a/_Dokumente/Protokolle/2019-06-12_Protokoll.md b/_Dokumente/Protokolle/2019-06-12_Protokoll.md index e8b7fc5..0b66365 100644 --- a/_Dokumente/Protokolle/2019-06-12_Protokoll.md +++ b/_Dokumente/Protokolle/2019-06-12_Protokoll.md @@ -5,15 +5,21 @@ _Teilnehmer: Levin Faber, Alexej Komnik, Tobias Schiffarth, Kai Senkowski_ _Ort: Schule_ ## Agenda -* Projetkstrukturplan und Zeitplan +* Projektstrukturplan und Zeitplan * Pflichtenheft * Abgabe Use-Case-Diagramm * Endpoints -* Was soll alles im Prototyp enthalten sein? +* Enthaltene Funktionen im Prototyp? ## Ergebnisse -* * Pflichtenheft ist abgegeben +* Pflichenheft initial vollständig +* PSP vervollständigt +* Prototyp (enthaltene Funktionen) + * Login + * Antragsgformular + * Wochenübersicht für Dozenten (Dozenten) + * Kurse erstellen/bestätigen (Verwaltung) ## Resultierende Aufgaben |Aufgabe|Verantwortlicher|Erledigt|