Academy
Projekt erstellen

Projekt erstellen

Erklärung

Im bisherigen Kurs haben wir gelernt, wie wir Prozesse modellieren und mit der 5Minds-Engine ausführen können. In diesem Kurs wird es darum gehen, diese modellierten Prozesse in eine Software zu integrieren, sodass wir auf Basis unserer Prozesse echte Software-Applikationen erstellen können.

Bei diesem Teil handelt es sich um die Pro-Code-Variante des Kurses. Das bedeutet, dass wir mit Hilfe des Full-Stack-Entwicklungsframeworks Next.js (opens in a new tab) und dem 5Minds-App.SDK (opens in a new tab) eine Anwendung erstellen werden. Diese Anwendung wird am Ende eine Benutzeroberfläche und eine serverseitge Integration zur Engine haben. Da es sich um ein Full-Stack-Framework handelt, hat man danach die nötige Infrastruktur, um alle möglichen Full-Stack-Applikationen prozessorientiert zu erstellen.

Voraussetzungen

Um mit diesem Kurs fortzufahren müssen folgende Entwicklungswerkzeuge und Frameworks installiert sein:

  1. Node.js (opens in a new tab) (Version 18 oder höher)
  2. Docker Desktop (opens in a new tab)
  3. VS Code (opens in a new tab)

Projekt erstellen

Um ein neues Projekt zu erstellen, führen wir folgenden Befehl in der Konsole aus:

npx create-processcube-app@6.2.1-alpha.1

Es kann sein, dass hier eine Aufforderung erscheint, dass diese entsprechende Version erst installiert werden muss. In diesem Fall einfach bestätigen.

Daraufhin werden wir nach ein paar Informationen gefragt, die wir eingeben müssen. Für die meisten Punkte können wir die Standardwerte verwenden, indem wir einfach Enter drücken. An ein paar Stellen müssen wir folgende abweichende Antworten geben:

  1. Would you like to use ProcessCube Authority? - Hier wählen wir "Yes"
  2. Would you like to use External Tasks? - Hier wählen wir "Yes"
  3. Would you like to use Next UI? (Next UI implies and installs Tailwind CSS.) - Hier wählen wir "Yes"

Falls hier falsche Eingaben gemacht wurden, gibt es zwei Möglichkeiten zur Korrektur: Entweder löscht man das generierte Projekt komplett und startet den Befehl erneut, oder man nimmt die notwendigen Änderungen manuell vor. Die entsprechenden Schritte werden in den jeweiligen Kurs-Kapiteln erläutert.

Danach beginnt eine Installation. Im Anschluss ist ein neues Projekt erstellt und wir können mit der Entwicklung beginnen.

Projektstruktur

Zunächst schauen wir uns aber die Projektstruktur an.

root-Folder

Im root-Folder finden wir die Ordner .processcube/, apps/ und database/. Daneben liegen hier noch die README.md, die .gitignore und die docker-compose.yml.

In der README steht, wie man die Anwendung starten kann. Die .gitignore ist dafür da, um bestimmte Dateien und Ordner von der Versionskontrolle auszuschließen. Die docker-compose.yml ist dafür da, um die Anwendungen der ProcessCube®-Plattform über Docker zu starten.

Wenn wir uns den Inhalt der docker-compose.ymlanschauen, sehen wir, dass hier drei Container definiert sind:

  1. die 5Minds-Engine
  2. ein Postgres-Datenbank Server
  3. die 5Minds-Authority

Im Ordner database/ finden wir ein einfaches Hilfsskript, um die Datenbanken zu initialisieren. Das können wir im weiteren Verlauf ignorieren.

Die wichtigsten Ordner, in denen wir arbeiten werden, sind .processcube/ und apps/.

.processcube

In diesem Ordner sind die Konfigurationsdateien für die ProcessCube®-Produkte abgelegt. Im späteren Verlauf des Kurses werden wir hier einzelne Dateien genauer betrachten und bearbeiten.

Wenn wir uns die docker-compose.yml anschauen, sehen wir, dass die entsprechenden Config-Dateien in die jeweiligen Container gemounted werden. Auf diese Weise werden in diesem Setup die Produkte konfiguriert.

apps

In diesem Ordner werden wir den Großteil unserer Arbeit durchführen. Hier befindet sich der Unterordner next_app/, welcher die eigentliche Next.js-Anwendung enthält.

In komplexeren Anwendungen mit mehreren Frontends oder Backends können hier auch mehrere Ordner liegen.

Prozesse ablegen

Nachdem wir das Projekt angelegt haben, können wir die modellierten Prozesse hier ablegen. Es ist üblich, im Root-Verzeichnis einen Ordner processes/ anzulegen und die Prozesse darin zu speichern.

Auch hier können wir einen Blick in die docker-compose.yml werfen und feststellen, dass dieser Ordner in den Engine-Container gemountet wird. Dadurch werden die Prozesse beim Start der Engine automatisch deployed.

Ein erster Test

ProcessCube® starten

⚠️

Beim erstmaligen Aufsetzen ist es nötig, der lokalen /etc/hosts-Datei zwei Einträge hinzuzufügen:

127.0.0.1	engine
127.0.0.1	authority

Nachdem wir das Projekt erstellt haben, können wir es starten. Dazu gehen wir in die Konsole, navigieren in den Ordner des erstellten Projekts und geben folgenden Befehl ein:

docker compose up -d

Daraufhin werden die Container gestartet und wir können uns über das Studio mit der Engine verbinden. Dazu öffnen wir das Studio, klicken links in der Menuleiste auf den Button Connections und fügen in der dort erscheinenden Liste eine neue Engine hinzu. Die Engine ist über die Adresse http://localhost:8000 erreichbar. Diese tippen wir in dem Dialog ein und klicken anschließend auf Connect.


Über dieselbe Engine Adresse http://localhost:8000 kann im Browser auch die API Schnittstellen Dokumentation der Engine eingesehen werden.

Next.js-Anwendung starten

Um die Next.js-Anwendung zu starten, gehen wir in die Konsole, navigieren in den Ordner apps/next_app/ und geben folgenden Befehl ein:

npm run dev

Danach ist die Anwendung im Browser unter http://localhost:3000 erreichbar. Wenn wir die Anwendung aufrufen, werden wir als erstes auf eine Login-Seite weitergeleitet. Hier können wir uns mit den Standard-Credentials admin und admin einloggen.

Abschluss

Wenn das alles geklappt hat, können wir mit der Entwicklung beginnen. Im nächsten Kapitel werden wir uns die Benutzeroberfläche genauer anschauen und die ersten Schritte in der Entwicklung machen.