Lokale Installation

In ChatGPT öffnen

Dieser Abschnitt der Dokumentation behandelt die erforderlichen Schritte nur für Benutzer, die webforJ für die Web- und/oder App-Entwicklung mit einer lokalen BBj-Instanz auf ihrem Computer verwenden möchten. Diese Installation ermöglicht es den Benutzern nicht, zum webforJ-Foundation-Code selbst beizutragen.

Info

Dieses Tutorial behandelt die Installation auf einem Windows-System – die Installationsschritte können für Mac/Linux-Betriebssysteme abweichen.

Die Installation wird in die folgenden Schritte unterteilt:

1. BBj herunterladen und installieren
2. Verwendung des BBj Plugin Managers zum Erstellen Ihrer App
3. Starten Ihrer App

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie die notwendigen Voraussetzungen für die Einrichtung und Verwendung von webforJ überprüft haben. Dies stellt sicher, dass Sie alle erforderlichen Werkzeuge und Konfigurationen bereit haben, bevor Sie mit Ihrem Projekt beginnen.

1. BBj herunterladen und installieren

Während Sie diesen Schritt ausführen, stellen Sie sicher, dass Sie die BBj-Version installieren, die der gleichen webforJ-Version entspricht.

Dieses Video kann Ihnen bei der Installation von BBj helfen, falls Sie Unterstützung bei der Einrichtung benötigen. Der Installationsbereich der BASIS-Website ist unter diesem Link zu finden.

Tipp

Es wird empfohlen, die neueste stabile Überarbeitungsbuild von BBj zu verwenden und "BBj" aus der Liste der Optionen auszuwählen, ohne Barista oder Addon.

2. Installieren und Konfigurieren des webforJ-Plugins

Sobald BBj installiert ist, kann der Plugin Manager aufgerufen werden, um die Werkzeuge zu installieren, die zur Konfiguration von webforJ benötigt werden. Als erstes geben Sie "Plugin Manager" in das Startmenü oder Finder ein.

Nachdem der Plugin-Manager geöffnet wurde, navigieren Sie zur Registerkarte "Verfügbare Plugins" oben.

Sobald Sie sich in diesem Abschnitt befinden, aktivieren Sie das Kontrollkästchen "Zeige Versionen in Entwicklung".

Der DWCJ-Eintrag sollte nun in der Liste der verfügbaren Plugins zum Herunterladen sichtbar sein. Klicken Sie auf diesen Eintrag in der Liste, um ihn auszuwählen.

Mit dem ausgewählten DWCJ-Eintrag klicken Sie auf die Schaltfläche "Installieren".

Sobald das Plugin installiert ist, klicken Sie auf die Registerkarte "Installierte Plugins" oben.

Diese Registerkarte zeigt die installierten Plugins an, die nun den DWCJ-Eintrag enthalten sollten. Klicken Sie auf den Eintrag in der Liste.

Mit dem ausgewählten DWCJ-Eintrag klicken Sie auf die Schaltfläche "Konfigurieren".

Im geöffneten Fenster klicken Sie auf die Schaltfläche "Maven Remote Install aktivieren" unten links im Fenster.

Tipp

Alternativ können Sie zum Verzeichnis bin innerhalb Ihres bbx-Ordners navigieren und den folgenden Befehl ausführen:

./bbj -tIO DWCJ/cli.bbj - enable_remote_install

Ein Dialog sollte anzeigen, dass die Remote-Installation aktiviert wurde. Klicken Sie auf "OK", um diesen Dialog zu schließen.

3. Verwendung des Starter-Projekts

Sobald BBj und das erforderliche webforJ-Plugin installiert und konfiguriert sind, können Sie ein neues, strukturiertes Projekt über die Kommandozeile erstellen. Dieses Projekt enthält die notwendigen Werkzeuge, um Ihr erstes webforJ-Programm auszuführen.

Um ein neues bbj-hello-world-Projekt zu erstellen und zu scaffolden, folgen Sie diesen Schritten:

1. Navigieren Sie zum richtigen Verzeichnis: Öffnen Sie ein Terminal und wechseln Sie in den Ordner, in dem Sie Ihr neues Projekt erstellen möchten.
2. Führe den Befehl archetype:generate aus: Verwenden Sie den folgenden Maven-Befehl und passen Sie groupId, artifactId und version nach Bedarf für Ihr Projekt an.

Bash/Zsh

mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-bbj-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT  \
-DappName=MyApp

PowerShell

mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" " `
-DappName="MyApp"

Command Prompt

mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" " ^
-DappName="MyApp"

Argumentation	Erklärung
archetypeGroupId	Die Gruppen-ID des Archetyps ist com.webforj für webforJ-Archetypen.
archetypeArtifactId	Gibt den Namen des zu verwendenden Archetyps an.
archetypeVersion	Legt die zu verwendende Version des Archetyps fest. Dies stellt sicher, dass das generierte Projekt mit einer bestimmten Archetyp-Version kompatibel ist. Die Auswahl von LATEST wählt die aktuellste verfügbare Version aus.
groupId	Namespace für das generierte Projekt. Typisch strukturiert wie ein Java-Paket, z.B. org.example und wird verwendet, um Ihre Organisation oder Projektdomain eindeutig zu identifizieren.
artifactId	Gibt den Namen des generierten Projekts an. Dies wird der Name des resultierenden Artefakts und des Projektordners sein.
version	Legt die Version des generierten Projekts fest. Eine gängige Konvention ist MAJOR.MINOR-SNAPSHOT, wie 1.0-SNAPSHOT, wobei SNAPSHOT bedeutet, dass sich das Projekt noch in der Entwicklung befindet.
appName	Ein optionaler Parameter, der in der POM-Datei des generierten Projekts verwendet werden kann. Abhängig vom verwendeten webforJ-Archetyp kann er als Standardtitel für die Anwendung genutzt werden.

Nach Ausführung des Befehls wird Maven die benötigten Projektdateien generieren, um das Projekt auszuführen.

4. Die App starten

Sobald dies erledigt ist, führen Sie mvn install in Ihrem Projektverzeichnis aus. Dies wird das webforJ-Installations-Plugin ausführen und Ihnen Zugriff auf Ihre App ermöglichen. Um die App zu sehen, gehen Sie zu folgender URL:

http://localhost:YourHostPort/webapp/YourPublishName

Ersetzen Sie YourHostPort durch den Hostport, den Sie mit Docker konfiguriert haben, und YourPublishName wird durch den Text innerhalb des <publishname>-Tags der POM ersetzt. Wenn Sie alles korrekt gemacht haben, sollten Sie Ihre App sehen können.