Das Projekt Strategienavigator basiert auf einer Idee aus der Software CRM-Navigator aus dem Jahre 2007. Der Strategienavigator sollen jedem einen einfachen Zugang zu strategischen Werkzeugen bieten. Insbesondere ist der Einsatz in der Hochschule geplant. Aber auch allen Interessierten stehen die Werkzeuge zur Verfügung.
Das Projekt wird an der Jade Hochschule in Wilhelmshaven am Fachbereich Management Information Technologie 🔗 entwickelt.
Das Frontend wurde mittels Create React App erstellt. Das Strategienavigator-Backend ist hier 🔗 zu finden.
Interne Projektinformationen 🔗
| Programm/Package | min. Version |
|---|---|
| NodeJS | > = 14.17.6 |
| npm | > = 7.19.1 |
- WebStorm
- Visual Studio
- Visual Studio Code
Zu Beginn muss sich das Github-Repository heruntergeladen und in einen von Ihnen gewählten Ordner platziert werden.
(Für Mitentwickelnde kann dies auch durch Git oder Github-Desktop geschehen)
Folgend muss sich NodeJS heruntergeladen werden. Dies kann hier 🔗 geschehen. Achten Sie
hierbei auf die oben genannten Mindestvoraussetzungen. Nach der Installation von NodeJS haben Sie die nötigen Programme
und Programmierwerkzeuge um die Installation fortzusetzen.
Nun muss die Kommandozeile gestartet werden und ins Hauptverzeichnis des Repositories manövriert werden. Wenn Sie sich nicht bereits im Hauptverzeichnis des Repositories befinden, können Sie mithilfe des cd-Befehls zum Hauptverzeichnis gelangen.
cd <pfad>
Um die benötigten Bibliotheken und Pakete zu installieren, wird der Node-Package-Manager (npm) benutzt. Der
konkrete Befehl lautet hierzu:
npm installDieser Schritt kann je nach System und Internetverbindung mehr Zeit in Anspruch nehmen.
Um nun das Projekt zu konfigurieren, muss die .env.development.local Datei erstellt und eingerichtet werden. Hierzu kopieren wir die mitgelieferte .env.development.local.example Datei.
copy .env.development.local.example .env.development.local // Windowscp .env.development.local.example .env.development.local // LinuxWenn die .env.development.local Datei jetzt vorhanden ist, muss diese bearbeitet werden. Öffnen Sie hierzu die Datei
und stellen Sie
die vorhandenen Umgebungsvariablen ein. Hierzu können Sie folgende Dokumentation benutzen.
Nun ist die Installation abgeschlossen und der Entwicklungsserver kann gestartet werden. Hierzu ist folgender Befehl auszuführen:
npm startStartet den Entwicklungsserver.
Der Server ist nun unter http://localhost:3000 🔗 erreichbar.
Sämtliche Editierungen werden beim Abspeichern automatisch aktualisiert.
Für die Nutzung von Cypress zur Erstellung und Testen von Szenarien können sie folgende Dokumentantion verwenden.
- Alles was keine Dokumentation oder Kommentare sind, muss in der englischen Sprache angefertigt werden.
- Alle Dokumentationen sollten in der deutschen Sprache angefertigt werden.
- Variablen- und Methodenbezeichnungen werden in Camelcase geschrieben.
- Wenn möglich sollen Dependency-Injection für Services verwendet werden.
Wenn ein Fehler gefunden wird, diesen bitte als Issue im Github Repository eintragen.
Weiterhin kann auf die Liste der Projektteilnehmer in Github verwiesen werden.