From 0c1550c7a74efa066fc7b8d4358d1b4441dfc0db Mon Sep 17 00:00:00 2001 From: Marcel Schwarz Date: Sat, 30 May 2020 20:50:22 +0200 Subject: [PATCH] Extract large sections into separate files --- documentation/documentation.tex | 97 +++++--------------- documentation/parts/abstract.tex | 20 ---- documentation/parts/android.tex | 16 ++++ documentation/parts/backend.tex | 15 +++ documentation/parts/entwicklungsumgebung.tex | 9 ++ documentation/parts/frontend.tex | 19 ++++ documentation/parts/projektplanung.tex | 12 +++ 7 files changed, 96 insertions(+), 92 deletions(-) delete mode 100644 documentation/parts/abstract.tex create mode 100644 documentation/parts/android.tex create mode 100644 documentation/parts/backend.tex create mode 100644 documentation/parts/entwicklungsumgebung.tex create mode 100644 documentation/parts/frontend.tex create mode 100644 documentation/parts/projektplanung.tex diff --git a/documentation/documentation.tex b/documentation/documentation.tex index 768938a..b8a3fcb 100644 --- a/documentation/documentation.tex +++ b/documentation/documentation.tex @@ -51,7 +51,26 @@ \include{parts/titlepage} -\include{parts/abstract} +\begin{abstract} + {\huge Checkliste Lieferobjekte} + + \begin{itemize} + \item Ein Journal (z.B. Excel in Dropbox, Office 365, Google), in dem jedes Projektmitglied Tages- und Themenspezifisch seine geleisteten Arbeiten mit Aufwandsangabe listet. Z.b. "Hans 12.4 3 Std Backend Coding"- Das Journal muss zeitnah geführt werden und verfügbar sein. Ein unvollständiges Zeitjournal führt zur Abwertung in der Benotung. + \item Projektdokumentation (*: ca. 15-25 Seiten, je nach Bilderdichte) + \begin{itemize} + \item Source Code und alle erstellten Dokumente + \item Erläuterung des Designs (*) + \item Einrichtung der Entwicklungsumgebung (*) \\ + (falls anwendbar, Standarddinge wie Eclipse, Android SDK müssen nicht detailliert erwähnt werden): + \begin{itemize} + \item Welche Frameworks wurden für die Entwicklung benutzt und was gab es bei der Konfiguration / Installation dieser Tools zu beachten? + \item Wie wurden die Zielanwendungen erzeugt und z.B. auf ein Zielgerät oder Server übertragen und dort aktiviert? + \end{itemize} + \item Projektbericht: Wie sind Sie vorgegangen, was wollten Sie erreichen, was haben Sie gelernt, was gab es für Probleme, was haben Sie erreicht, wer hat was gemacht? + \end{itemize} + \item Datei mit der Präsentation + \end{itemize} +\end{abstract} \tableofcontents @@ -59,81 +78,15 @@ \include{parts/einleitung} -\chapter{Projektplanung} - \section{Ziel des Projekts} - \section{Definition des Workflows} - \subsection{Kommunikation} - \subsection{Sprints} - \subsection{Code-Owners} - \section{Sprintziele} - \subsection{Iteration 1} - \subsection{Iteration 2} - \subsection{Iteration 3} - \subsection{Iteration 4} - \subsection{Iteration 5} +\include{parts/projektplanung} -\chapter{Entwicklungsumgebung} - \section{Versionsverwaltung} - \subsection{GitLab} - \subsection{Umgang mit Issues} - \subsection{GitLab Wiki} - \subsection{Continuous Integration} - \section{Docker} - \section{Docker-Compose} - \section{Infrastruktur} +\include{parts/entwicklungsumgebung} -\chapter{Backend} - \section{Technologiebeschreibung} - \subsection{Spring Boot} - \subsection{MariaDB} - \subsection{Weitere Open Source Software} - \subsection{Spezielles Setup} - \section{Umsetzung} - \subsection{Spring Entities} - \subsection{Sicherheit durch JWT} - \subsection{Repositories} - \subsection{Projections} - \section{Endpoints} - \subsection{HAL und Paging} - \section{Probleme und Lösungen} - \section{Deployment} +\include{parts/backend} -\chapter{Web-Frontend} - \section{Technologiebeschreibung} - \subsection{Vuejs} - \subsection{Vuetify} - \section{Farbschema und Designsprache} - \section{Umsetzung} - \subsection{Einarbeitung} - \subsection{Arbeit mit Dummy-Daten} - \subsection{Authentifizierung} - \subsection{Abrufen der Daten in Listen} - \subsection{Ändern und Hinzufügen von Daten} - \subsection{Auswertung in Diagrammen} - \subsection{Administrator Funktionalitäten} - \section{Funktionen der Website} - \subsection{Home} - \subsection{Time Records} - \subsection{...} - \subsection{Probleme und Lösungen} - \section{Deployment} +\include{parts/frontend} -\chapter{Android-App} - \section{Technologiebeschreibung} - \subsection{Android SDK} - \subsection{Kotlin} - \subsection{Retrofit} - \section{Farbschema und Designsprache} - \section{Umsetzung} - \subsection{Design der Activities} - \subsection{Authentifizierung} - \subsection{Anzeige der Daten in der Main Activity} - \subsection{Geofencing} - \section{Funktionen der App} - \subsection{Login Screen} - \subsection{Main Activity} - \section{Probleme und Lösungen} - \section{Deployment} +\include{parts/android} \chapter{Vollständiger Application Stack} diff --git a/documentation/parts/abstract.tex b/documentation/parts/abstract.tex deleted file mode 100644 index 3b9ea2b..0000000 --- a/documentation/parts/abstract.tex +++ /dev/null @@ -1,20 +0,0 @@ -\begin{abstract} - {\huge Checkliste Lieferobjekte} - - \begin{itemize} - \item Ein Journal (z.B. Excel in Dropbox, Office 365, Google), in dem jedes Projektmitglied Tages- und Themenspezifisch seine geleisteten Arbeiten mit Aufwandsangabe listet. Z.b. "Hans 12.4 3 Std Backend Coding"- Das Journal muss zeitnah geführt werden und verfügbar sein. Ein unvollständiges Zeitjournal führt zur Abwertung in der Benotung. - \item Projektdokumentation (*: ca. 15-25 Seiten, je nach Bilderdichte) - \begin{itemize} - \item Source Code und alle erstellten Dokumente - \item Erläuterung des Designs (*) - \item Einrichtung der Entwicklungsumgebung (*) \\ - (falls anwendbar, Standarddinge wie Eclipse, Android SDK müssen nicht detailliert erwähnt werden): - \begin{itemize} - \item Welche Frameworks wurden für die Entwicklung benutzt und was gab es bei der Konfiguration / Installation dieser Tools zu beachten? - \item Wie wurden die Zielanwendungen erzeugt und z.B. auf ein Zielgerät oder Server übertragen und dort aktiviert? - \end{itemize} - \item Projektbericht: Wie sind Sie vorgegangen, was wollten Sie erreichen, was haben Sie gelernt, was gab es für Probleme, was haben Sie erreicht, wer hat was gemacht? - \end{itemize} - \item Datei mit der Präsentation - \end{itemize} -\end{abstract} \ No newline at end of file diff --git a/documentation/parts/android.tex b/documentation/parts/android.tex new file mode 100644 index 0000000..1022887 --- /dev/null +++ b/documentation/parts/android.tex @@ -0,0 +1,16 @@ +\chapter{Android-App} + \section{Technologiebeschreibung} + \subsection{Android SDK} + \subsection{Kotlin} + \subsection{Retrofit} + \section{Farbschema und Designsprache} + \section{Umsetzung} + \subsection{Design der Activities} + \subsection{Authentifizierung} + \subsection{Anzeige der Daten in der Main Activity} + \subsection{Geofencing} + \section{Funktionen der App} + \subsection{Login Screen} + \subsection{Main Activity} + \section{Probleme und Lösungen} + \section{Deployment} \ No newline at end of file diff --git a/documentation/parts/backend.tex b/documentation/parts/backend.tex new file mode 100644 index 0000000..6095505 --- /dev/null +++ b/documentation/parts/backend.tex @@ -0,0 +1,15 @@ +\chapter{Backend} + \section{Technologiebeschreibung} + \subsection{Spring Boot} + \subsection{MariaDB} + \subsection{Weitere Open Source Software} + \subsection{Spezielles Setup} + \section{Umsetzung} + \subsection{Spring Entities} + \subsection{Sicherheit durch JWT} + \subsection{Repositories} + \subsection{Projections} + \section{Endpoints} + \subsection{HAL und Paging} + \section{Probleme und Lösungen} + \section{Deployment} \ No newline at end of file diff --git a/documentation/parts/entwicklungsumgebung.tex b/documentation/parts/entwicklungsumgebung.tex new file mode 100644 index 0000000..92048b5 --- /dev/null +++ b/documentation/parts/entwicklungsumgebung.tex @@ -0,0 +1,9 @@ +\chapter{Entwicklungsumgebung} + \section{Versionsverwaltung} + \subsection{GitLab} + \subsection{Umgang mit Issues} + \subsection{GitLab Wiki} + \subsection{Continuous Integration} + \section{Docker} + \section{Docker-Compose} + \section{Infrastruktur} \ No newline at end of file diff --git a/documentation/parts/frontend.tex b/documentation/parts/frontend.tex new file mode 100644 index 0000000..28e24aa --- /dev/null +++ b/documentation/parts/frontend.tex @@ -0,0 +1,19 @@ +\chapter{Web-Frontend} + \section{Technologiebeschreibung} + \subsection{Vuejs} + \subsection{Vuetify} + \section{Farbschema und Designsprache} + \section{Umsetzung} + \subsection{Einarbeitung} + \subsection{Arbeit mit Dummy-Daten} + \subsection{Authentifizierung} + \subsection{Abrufen der Daten in Listen} + \subsection{Ändern und Hinzufügen von Daten} + \subsection{Auswertung in Diagrammen} + \subsection{Administrator Funktionalitäten} + \section{Funktionen der Website} + \subsection{Home} + \subsection{Time Records} + \subsection{...} + \subsection{Probleme und Lösungen} + \section{Deployment} \ No newline at end of file diff --git a/documentation/parts/projektplanung.tex b/documentation/parts/projektplanung.tex new file mode 100644 index 0000000..84fdb7f --- /dev/null +++ b/documentation/parts/projektplanung.tex @@ -0,0 +1,12 @@ +\chapter{Projektplanung} + \section{Ziel des Projekts} + \section{Definition des Workflows} + \subsection{Kommunikation} + \subsection{Sprints} + \subsection{Code-Owners} + \section{Sprintziele} + \subsection{Iteration 1} + \subsection{Iteration 2} + \subsection{Iteration 3} + \subsection{Iteration 4} + \subsection{Iteration 5} \ No newline at end of file