Projekt erstellen
Erklärung
In diesem Kurs werden wir lernen, wie wir modellierte Prozesse in eine Software integrieren können, sodass wir auf Basis unserer Prozesse echte Software-Applikationen erstellen können - aber diesmal mit Low-Code.
Bei diesem Teil handelt es sich um die Low-Code-Variante des Kurses. Das bedeutet, dass wir mit Hilfe des Low-Code-Entwicklungsframeworks Node-RED (opens in a new tab) eine Anwendung erstellen werden.
Node-RED ist eine Low-Code-Plattform die es ermöglicht, Full-Stack-Anwendungen zu erstellen. Wir reden hier also von
einem vielseitigen und starken Werkzeug, um modellierte Prozesse in IT-Landschaften zu integrieren. Wir bezeichnen
es deshalb auch als Integrations-Software oder Integrations-Framework.
Aufsetzen eines Projekts
Wenn das Tutorial für die Pro-Code-Variante/Grundlagen des Kurses durchgeführt wurde, kann dieser Schritt übersprungen werden. Es kann dann einfach im selben Projekt weitergearbeitet werden.
Der Start eines Projekts ist in den ersten Schritte genau wie bei der Pro-Code-Variante. Wir brauchen zu allererst eine Engine, ein docker-compose-Setup und eine Standard-Ordnerstruktur.
Wir starten also ähnlich wie bei der Pro-Code-Variante mit
create-processcube-app, allerdings ist für uns diesmal nur eine Frage relevant:
Would you like to use ProcessCube Authority?- Hier wählen wir "Yes"
Die restlichen Fragen beziehen sich sonst alle auf die Next.js-App. Da wir aber eine Node-RED-App erstellen wollen, sind diese für uns nicht relevant und wir können die Standard-Werte akzeptieren.
Wenn das Tutorial für die Pro-Code-Variante des Kurses noch nicht durchgeführt wurde, sollte dem gesamten Teil gefolgt werden, bevor mit dem nächsten Schritt weiter gemacht wird. Es sind wichtige Inhalte zu beachten, z.B. die Konfiguration der etc/hosts-Datei.
Node-RED-App hinzufügen
Nachdem das Projekt erstellt wurde, können wir nun die Node-RED-App hinzufügen. Dazu öffnen wir die docker-compose.yml-Datei
und fügen diesen Container hinzu:
services:
# ...
nodered_app:
image: 5minds/processcube_lowcode:2.0.0-feature-e6d9f1-m1yq224r
ports:
- 3003:1880
environment:
- NODERED_NAME=App
- ENGINE_URL=http://engine:80
- TZ=Europe/Berlin
- NODERED_AUTHORITY_URL=http://authority:11560
- NODERED_CLIENT_ID=nodered_app
- NODERED_CLIENT_SECRET=nodered_app_secret
- NODERED_BASE_URL=http://localhost:3003
volumes:
- ./apps/nodered_app/data:/dataDie Konfiguration definiert einen Docker-Compose Service (opens in a new tab)
namens nodered_app. Dieser Service basiert auf dem Image
5minds/processcube_lowcode:2.0.0-feature-e6d9f1-m1yq224r und ist auf Port 3003 zugänglich.
Anschließend fügen wir noch in der Konfigurationsdatei der Authority die Node-RED-App als Client hinzu:
{
// ...
"otherClients": [
// ...
{
"clientId": "nodered_app",
"clientSecret": "nodered_app_secret",
"scope": "openid email profile",
"grant_types": ["authorization_code", "refresh_token"],
"response_types": ["code"],
"redirect_uris": [
"http://localhost:3003/auth/strategy/callback",
"http://localhost:3003/auth/callback",
"http://localhost:3003/auth/dashboard/callback"
],
"post_logout_redirect_uris": ["http://localhost:3003/"],
"corsOrigins": ["http://localhost:3003"]
}
]
// ...
}Die Konfiguration wird in der Datei .processcube/authority/config.json unter otherClients ergänzt, nicht
überschrieben.
gitignore anpassen
Einleitung
Die .gitignore-Datei ist eine zentrale Konfigurationsdatei in einem Git-Projekt, die festlegt, welche Dateien und Verzeichnisse Git ignorieren soll. Diese Dateien werden weder versioniert noch in das Repository hochgeladen. Das hilft dabei, sensible Informationen, unnötige Dateien (z. B. temporäre Dateien), und vom Benutzer generierte Inhalte (z. B. Cache-Dateien oder Logfiles) vom Versionsverlauf fernzuhalten und das Projekt schlank und sicher zu halten.
Aufbau und Funktionsweise
Die .gitignore-Datei wird im Stammverzeichnis des Projekts abgelegt. Jede Zeile der Datei enthält entweder einen Dateinamen oder ein Verzeichnismuster, das ignoriert werden soll. Muster mit Wildcards wie *, ** oder ? ermöglichen es, ganze Verzeichnisse oder Dateigruppen auszuschließen. Spezifische Dateien können durch das Voranstellen eines Ausrufezeichens (!) vom Ignorieren ausgeschlossen werden.
Ergänzte Einträge zur .gitignore-Datei für Node-RED
In diesem Projekt arbeiten wir mit einer Node-RED-Instanz, die ebenfalls bestimmte Konfigurations- und Daten-Dateien mitbringt. Um sicherzustellen, dass nur die nötigen Konfigurationsdateien in der Versionierung landen und unnötige Daten nicht im Repository gespeichert werden, wurden folgende Regeln hinzugefügt:
# Node-RED
**/nodered_app/*
!**/nodered_app/package.json
!**/nodered_app/package-lock.json
!**/nodered_app/flows/*.json
!**/nodered_app/flows_cred.json
!**/nodered_app/settings.jsErklärung der Einträge
**/nodered_app/*: Dieser Eintrag ignoriert grundsätzlich alle Dateien und Verzeichnisse im Ordner nodered_app. Damit verhindern wir, dass unnötige oder temporäre Daten in das Git-Repository gelangen, z. B. generierte Daten und Zwischenstände.!**/nodered_app/package.jsonund!**/nodered_app/package-lock.json: Diese Dateien definieren die Abhängigkeiten der Node-RED-Anwendung. Um sicherzustellen, dass alle Entwickler dieselben Abhängigkeiten nutzen, müssen diese beiden Dateien versioniert werden. Daher heben wir diese vom allgemeinen Ausschluss wieder auf.!**/nodered_app/flows/*.jsonund!**/nodered_app/flows_cred.json: Die .json-Dateien im flows-Ordner und flows_cred.json enthalten die spezifischen Flow-Konfigurationen von Node-RED. Diese sind zentral für die Funktionalität der Anwendung und werden daher ebenfalls im Repository benötigt, um die Anwendung in jedem Setup konsistent bereitzustellen.!**/nodered_app/settings.js: Diese Datei enthält die Node-RED-Einstellungen und ist wichtig, um die Applikation in einer standardisierten Weise bereitzustellen. Auch sie wird daher versioniert.
Anwendungen starten
Danach können wir die Anwendungen starten, indem wir in der Konsole folgenden Befehl ausführen:
docker compose upAn dieser Stelle ist es nicht unwahrscheinlich, dass die passenden Berechtigungen zum Pullen des Dockerimages für die LowCode-App fehlen. In diesem Fall wende dich bitte an deine Ansprechpartner bei 5Minds.
Danach ist die Anwendung im Browser unter http://localhost:3003 erreichbar.
Login
Wenn wir die Anwendung aufrufen, werden wir als erstes auf eine Login-Seite weitergeleitet. Hier können wir uns mit den Standard-Credentials
- Username:
adminund - Password:
admin
einloggen.
Abschluss
Wenn das alles geklappt hat, können wir mit der Entwicklung beginnen. Im nächsten Kapitel werden wir uns anschauen, wie wir eine Benutzeroberfläche mit Node-RED erstellen können.