EncroShare Abgabe

Dies ist die Abgabe für die EncroShare App.

Repositories

Das Projekt wurde in GitLab der Hochschule Hof entwickelt und auf Github kopiert. Dabei wurden ebenfalls zum Management des Projektes Funktionen von GitLab verwendet, welche nicht im eigentlichen git-repository vorhanden sind. Darunter zählen Issues, Merge-Requests und Milestones.

Struktur

In einem Sammel-repository wurden Referenzen auf die eigentlichen Repositories, sowie das Wiki hinterlegt. Vorhanden in dieser Abgabe sind folgende Verzeichnisse:

• encroshare
  • Sammel-Repository zur Vereinigung von Backend, Frontend und Wiki
• encroshare/encroshare_backend
  • Beinhaltet das git-Repository für das Backend
• encroshare/encroshare_frontend
  • Beinhaltet das git-Repository für das Frontend
• encroshare/encroshare.wiki
  • Von GitLab bereitgestelltes Wiki, als Referenz zur lokalen Editierung außerhalb der GitLab Web-GUI

* Dokumentation kann über ein Webserver gehostet werden, um u.a. die Suche zu ermöglichen (Frontend siehe dartdoc). Beinhaltet jeweils die generierte Dokumentation, welche basierend auf dem Source-Code und damit verbundene Kommentare erstellt wurde und ist keine vollständige, hand-geschriebene Dokumentation des gesamten Codes. Dient lediglich als Möglichkeit, API nachzuschlagen und einen groben Überblick über Schnittstellen zu erhalten.

Binaries & Build

Im jeweiligen Repository (Frontend und Backend) ist eine README.md Datei, welche beschreibt, wie das jeweilige Projekt gebaut bzw. ausgeführt werden kann.

Die App enthält unter Einstellungen ein Textfeld zur Anpassung der IP/Domain des Backend-Servers. Die vorausgefüllte IP ist eine gehostete, öffentlich erreichbare Instanz des EncroShare Backends.

Logging

Für das Frontend wurde Sentry als Framework verwendet. Dieses ist in den Widget-Tree integriert und nimmt alle Exceptions und Probleme auf, welche dann auf einer Webseite visualisiert werden. Hierfür wird ein Benutzer benötigt:

---

Der Account wurde ausschließlich für das Projekt erstellt und wird nach der Notenbekanntgabe deaktiviert.

Im Einstellungen-Menü der App kann dann eine Exception geworfen werden, welche folglich an Sentry weitergeleitet wird.