Projekt

Die geplanten Features der Anwendung werden hier beschrieben. Das verwendete Software Design ist hier zusammengefasst. Allgemeine Guidelines, die das Team im Rahmen des Projekts einhalten möchte werden hier zusammengetragen. Der Funktionsumfang der Anwendung wird hier beschrieben. Beschreiben Sie hier Ihr Entwicklungsteam. Eine Übersicht über alle notwendigen Dokumente finden Sie hier.

Ändern Sie den Inhalt dieser Datei nicht!

Vorgehen bei der Entwicklung

Die Mindestanforderungen für die Verwendung von git in diesem Projekt ist die Nutzung zweier Branches master und dev. Entwickeln Sie die Anwendung im dev-Branch und überführen Sie ausschließlich getestet und funktionierende Versionen der Anwendung per Pull Request in den Master. Alle Pull Request müssen von mindestens einem Teammitglied (nicht den AutorInnen des Pull Requests) manuell geprüft und frei gegeben werden!

Live Version der Anwendung

Nach jedem Push in den Master wird Ihre Anwendung automatisch gebaut und über diese Adresse tba bereitgestellt (Wir richten dieses Setup für Sie ein, sobald die Projekte starten). Stellen Sie sicher, dass der aktuelle Inhalt des Masters jederzeit über die unten angegebenen Prozesse gebaut und gestartet werden kann.

Setup und Testing

Im Starterpaket ist ein einfacher Webserver vorgegeben, mit dem Sie die Inhalte des Ordners /app statisch ausliefern können. Benutzen Sie diesen, um Ihre Anwendung zu entwickeln und zu testen. Sollten Sie zu Realisierung Ihrer Anwendung eine komplexere Serverkomponente benötigen, können Sie die vorhandenen Dateien (index.js und server/AppServer.js) als Ausgangslage für eigene Erweiterungen nutzten. Speichern Sie alle weiteren, serverseitig verwendeten Dateien im Verzeichnis /server ab. Während der gesamten Projektzeit muss Ihre Anwendung stets über die Eingabe des Befehls npm start automatisiert gebaut und gestartet werden können!.

So nutzen Sie den vorgegebenen Server:

1. Führen Sie einmalig den Befehl npm install aus, um die notwendigen Abhängigkeiten (express) separat vom Startprozess zu installieren. Beim Aufruf des Befehls npm start werden automatisch auch der Befehl npm install und npm run build ausgeführt.

2. Führen Sie den Befehl npm start aus um die Anwendung zu starten. Der Inhalt des /app-Verzeichnis ist anschließend über die die Adresse http://localhost:/app erreichbar.

Automatisches Bauen der Anwendung

Unter Umständen müssen oder wollen Sie vor dem Ausführen bzw. Bereitstellen Ihrer Anwendung bestimmte Optimierungsvorgänge durchführen (z.B. mehrere Javascript-Dateien zu einer zusammenfügen oder Grafikdateien für die Verwendung im Browser anpassen). Versuchen Sie diese Schritte mithilfe entsprechende Node.js-Module zu lösen und implementieren Sie die Automatisierung in der Datei build.js. Sie können diese Datei über den Befehl npm run build starten. Dabei wird vor dem Ausführen der Datei der Javascript-Code unter app/resources/js/ auf Fehler und Warnungen (eslint) geprüft. Der automatisierte Bau der Software startet nur dann, wenn Ihr Code fehlerfrei ist.