Getting Started
Dit artikel beschrijft de stappen om een nieuwe webforJ-app te creëren met behulp van webforJ archetypen. Archetypen bieden voorgeconfigureerde projectstructuren en startcode, zodat je snel een project kunt opzetten en draaien.
Om een nieuwe webforJ-app vanuit een archetype te maken, kun je startforJ of de opdrachtregel gebruiken.
Voordat je begint, bekijk de noodzakelijke vereisten voor het opzetten en gebruiken van webforJ.
Gebruikmaken van startforJ
De eenvoudigste manier om een nieuwe webforJ-app te maken is met startforJ, dat een minimaal startproject genereert op basis van een gekozen webforJ-archetype. Dit startproject bevat alle vereiste afhankelijkheden, configuratiebestanden en een vooraf gemaakt lay-out, zodat je er meteen mee aan de slag kunt.
Aanpassen met startforJ
Wanneer je een app maakt met startforJ, kun je deze aanpassen door de volgende informatie te verstrekken:
- Basisprojectmetadata (App-naam, Groep-ID, Artifact-ID)
- webforJ-versie en Java-versie
- Thema kleur en icoon
- Archetype
- Smaak
Er zijn twee smaakopties om uit te kiezen, waarbij "webforJ Only" de standaard is:
- webforJ Only: Standaard webforJ-app
- webforJ + Spring Boot: webforJ-app met ondersteuning voor Spring Boot
webforJ wordt geleverd met verschillende vooraf gedefinieerde archetypen om je snel op weg te helpen. Voor een complete lijst van beschikbare archetypen, zie de archetypencatalogus.
Met deze informatie zal startforJ een basisproject maken vanuit je gekozen archetype met je gekozen aanpassingen.
Je kunt ervoor kiezen om je project als een ZIP-bestand te downloaden of het rechtstreeks naar GitHub te publiceren.
Zodra je je project hebt gedownload, open je de projectmap in je IDE en ga je verder met de app uitvoeren.
Gebruikmaken van de opdrachtregel
Als je de voorkeur geeft aan het gebruik van de opdrachtregel, kun je een project rechtstreeks genereren met behulp van het Maven-archetype:
Om een nieuw hello-world project te creëren en te scaffolden, volg deze stappen:
- Navigeer naar de juiste map: Open een terminal en ga naar de map waar je je nieuwe project wilt maken.
- Voer het archetype:generate commando uit: Gebruik de onderstaande Maven-opdracht en pas groupId, artifactId en versie aan zoals nodig voor jouw project.
- 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"
| Argumenten | Uitleg |
|---|---|
archetypeGroupId | De groeps-ID van de archetype is com.webforj voor webforJ archetypes. |
archetypeArtifactId | Geeft de naam van het te gebruiken archetype op. |
archetypeVersion | Geeft de versie van de archetype op die gebruikt moet worden. Dit zorgt ervoor dat het gegenereerde project compatibel is met een specifieke versie van de archetype. Het gebruik van LATEST selecteert de meest recente beschikbare versie. |
groupId | Geeft de naamruimte voor het gegenereerde project weer. Typisch gestructureerd als een Java-pakket, zoals org.example, en wordt gebruikt om uw organisatie of projectdomein uniek te identificeren. |
artifactId | Geeft de naam op van het gegenereerde project. Dit zal de naam zijn van het resulterende artifact en de projectmap. |
version | Definieert de versie van het gegenereerde project. Een gangbare conventie is MAJOR.MINOR-SNAPSHOT, zoals 1.0-SNAPSHOT, waarbij SNAPSHOT aangeeft dat het project nog in ontwikkeling is. |
flavor | Selecteer een projectvariant:
|
appName | Een optionele parameter die kan worden gebruikt in het POM-bestand van het gegenereerde project. Afhankelijk van de gebruikte webforJ-archetype kan het worden gebruikt als een standaardtitel voor de applicatie. |
Na het uitvoeren van de opdracht genereert Maven de projectbestanden die nodig zijn om het project uit te voeren.
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.