Getting Started
Dieser Artikel beschreibt die Schritte zur Erstellung einer neuen webforJ-App mit den webforJ Archetypen. Archetypen bieten vorkonfigurierte Projektstrukturen und Starter-Code, damit Sie ein Projekt schnell einrichten und ausführen können. Um eine neue webforJ-App aus einem Archetyp zu erstellen, können Sie startforJ oder die Befehlszeile verwenden.
Bevor Sie beginnen, überprüfen Sie die notwendigen Voraussetzungen für die Einrichtung und Nutzung von webforJ.
Verwendung von startforJ
Die einfachste Möglichkeit, eine neue webforJ-App zu erstellen, ist startforJ, das ein minimales Starterprojekt basierend auf einem gewählten webforJ-Archetyp generiert. Dieses Starterprojekt enthält alle erforderlichen Abhängigkeiten, Konfigurationsdateien und ein vorgefertigtes Layout, sodass Sie sofort mit dem Aufbau beginnen können.
Anpassen mit startforJ
Wenn Sie eine App mit startforJ erstellen, können Sie sie anpassen, indem Sie die folgenden Informationen bereitstellen:
- Grundlegende Projektdaten (App-Name, Gruppen-ID, Artefakt-ID)
- webforJ-Version und Java-Version
- Farbthema und Icon
- Archetyp
- Geschmac
Es gibt zwei Geschmacksoptionen zur Auswahl, wobei "webforJ Only" die Standardoption ist:
- webforJ Only: Standard-webforJ-App
- webforJ + Spring Boot: webforJ-App mit Unterstützung für Spring Boot
webforJ kommt mit mehreren vordefinierten Archetypen, um Ihnen den schnellen Einstieg zu erleichtern. Für eine vollständige Liste der verfügbaren Archetypen siehe den Archetypen-Katalog.
Mit diesen Informationen wird startforJ ein einfaches Projekt aus dem von Ihnen gewählten Archetyp mit Ihren gewählten Anpassungen erstellen. Sie können Ihr Projekt als ZIP-Datei herunterladen oder es direkt auf GitHub veröffentlichen.
Nachdem Sie Ihr Projekt heruntergeladen haben, öffnen Sie den Projektordner in Ihrer IDE und fahren Sie mit dem Ausführen der App fort.
Verwendung der Befehlszeile
Wenn Sie die Befehlszeile bevorzugen, können Sie ein Projekt direkt mit dem Maven-Archetyp generieren:
Um ein neues hello-world-Projekt zu erstellen und zu scaffolden, folgen Sie diesen Schritten:
- Navigieren Sie zum richtigen Verzeichnis: Öffnen Sie ein Terminal und wechseln Sie in den Ordner, in dem Sie Ihr neues Projekt erstellen möchten.
- 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
- PowerShell
- Command Prompt
mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-Dflavor=webforj \
-DappName=MyApp
mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-Dflavor="webforj" `
-DappName="MyApp"
mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-Dflavor="webforj" ^
-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. |
flavor | Wählen Sie einen Projektgeschmack aus:
|
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.
Running the app
Before running your app, install the prerequisites if you haven't yet. Then, navigate to the project's root directory and run the following command:
mvn
The shorthand mvn command works because the archetype's POM file includes a <defaultGoal> configuration that automatically runs the appropriate goal for your project type. If your project doesn't have <defaultGoal>, run the following:
# for a standard webforJ app
mvn jetty:run
# for a webforJ + Spring Boot app
mvn spring-boot:run
Once the server is running, open your browser and go to http://localhost:8080 to view the app.