Installation

Momentan (Stand. 01.2023) sind beide Applikationen über prototype.intia.de für die Hauptapplikation und admin.prototype.inita.de für die Admin-Applikation. Sollte dies nicht mehr der Fall sein mag oder man entscheidet sich dazu, die Applikationen lokal auszuführen, lässt sich das über die folgenden Schritte einrichten.

Nötige Installationen

• Docker
• Git

1. Projekt klonen

• Github Repository aufrufen unter diesem Link. https://github.com/cd-Roid/Praxisprojekt_2022 (opens in a new tab)
• Über den <>Code Button die https url des Repositorys aufrufen.
• Über die Github App oder über die Kommandozeile, das Repository lokal kopieren git clone https://github.com/cd-Roid/Praxisprojekt_2022.git

2. In den Projektordner Ordner navigieren

• Wurde das Projekt erfolgreich kopiert, befindet sich ein Ordner namens Praxisprojekt_2022 auf dem Rechner. Diesen Ordner kann man entweder über seinen Code Editor seiner Wahl öffnen. Zu empfehlen ist es jedoch über cd Praxisprojekt_2022 den Ordner in der Kommandozeile zu öffnen.
• Ist das Projekt geöffnet, kann man 3 Ordner sehen namens frontend, backend und admin-client. Der „frontend“ Ordner ist der Code für die Hauptapplikation. Der „admin-client“ Ordner ist für die Admin-Applikation und der Backendordner für den Backendserver. In jedem der Ordner müssen Anpassungen gemacht werden, damit das Projekt auf dem gewünschten Rechner laufen kann.

3. Umgebungsvariablen ausfüllen

In jedem Ordner ist eine Datei namens mock.env. Diese Dateien stellen die Umgebungsvariablen dar, die im Code abgelesen werden. Diese Dateien enthalten Pfade, die Schnittstellen und Verbindungen zu anderen Applikationen darstellt.

Um das Projekt lokal auszuführen, müssen die mock.env Dateien kopiert und ausgefüllt werden.

1. Die mock.env Dateien kopieren und im gleichen Ordner ablegen

2. Die Dateien umbenennen in .env

3. Variablen im .env ausfüllen

   Für die lokale Ausführung sind alle Variablen wichtig die nicht mit PROD* benannt sind. Variablen mit PROD* sind nur im backend .env zu finden. Da es sich hier um eine lokale Ausführung handelt, werden sich alle Urls im lokalen Netz befinden (https://localhost (opens in a new tab))

   • Backend .env

     1. PORT: Eine beliebige Portnummer die dem Backend entsprechen soll
     2. DB_NAME: der Name des Datenbank Dokuments der angelegt werden soll. Vorschlag (TIleDb)
     3. DB_URL: hier befindet sich der Zugang zur lokalen Datenbank. Hier wird die Standard Konfiguration genutzt. (mongodb://localhost:27017/)
     4. FRONTEND_CLIENT_URL: Hier ist die Url über die, die Hauptapplikation aufgerufen wird. Beispiel dafür ist (http://localhost:3000)
     5. ADMIN_CLIENT_URL: Hier ist die Url über die, die Admin Applikation aufgerufen wird. Beispiel dafür ist (http://localhost:3001)

   • Frontend .env

     1. REACT_APP_WS_PORT: Hier sollte eine Portnummer vergeben werden die der Portnummer des Backends entspricht.
     2. REACT_APP_BACKEND_URL: Diese Variable beinhaltet die Url zum Backend. Es muss hier nicht angegeben werden weil in der Docker Compose Datei die Variable auf „localhost:9000“ gesetzt ist. Möchte man aber eine andere verwenden dann kann man einfach die Variable hier ändern und im Docker Compose (DEV) entfernen.

   • Admin-Client .env

     • REACT_APP_BACKEND_URL: Die gleichen Regeln für die gleichnamige Variable im Frontend .env gelten auch hier.

4. Applikation starten

Nachdem alles eingerichtet ist kann man die Applikation über den command docker compose -f "docker-compose.dev.yml" up -d --build --remove-orphans starten. Dieser Prozess dauert 1 - 2 Minuten. Nachdem alles installiert und gestartet wurde sind die Applaiktionen über die angegebenen Urls erreichbar und können verwendet werden.