Getting Started
Dit artikel beschrijft de stappen om een nieuwe webforJ-app te maken met behulp van webforJ archetypes. Archetypes bieden vooraf geconfigureerde projectstructuren en startercode, 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 nodige vereisten voor het opzetten en gebruiken van webforJ.
Gebruik maken van startforJ
De eenvoudigste manier om een nieuwe webforJ-app te maken, is met startforJ, dat een minimaal starterproject genereert op basis van een gekozen webforJ-archetype. Dit starterproject bevat alle vereiste afhankelijkheden, configuratiebestanden en een vooraf gemaakte lay-out, zodat je er meteen aan kunt beginnen.
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, Artefact-ID)
- webforJ-versie en Java-versie
- Thema kleur en pictogram
- 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
De Spring Boot-smaak is alleen beschikbaar in webforJ versie 25.02 en hoger. Als je deze optie kiest, zorg er dan voor dat je een compatibele versie selecteert.
webforJ wordt geleverd met verschillende vooraf gedefinieerde archetypes om je te helpen snel aan de slag te gaan. Voor een complete lijst van beschikbare archetypes, zie de archetypes catalogus.
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 direct 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.
Gebruik maken van de opdrachtregel
Als je de voorkeur geeft aan de opdrachtregel, kun je een project rechtstreeks genereren met behulp van het Maven-archetype:
Om een nieuw hello-world
project te maken en op te zetten, volg deze stappen:
- Navigeer naar de juiste directory: Open een terminal en ga naar de map waar u uw nieuwe project wilt maken.
- Voer het archetype:generate commando uit: Gebruik het Maven commando hieronder en pas groupId, artifactId en version aan naar behoefte voor uw 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"
Argument | Uitleg |
---|---|
archetypeGroupId | De groep ID van het archetype is com.webforj voor webforJ archetypes. |
archetypeArtifactId | Specificeert de naam van het te gebruiken archetype. |
archetypeVersion | Specificeert de versie van het te gebruiken archetype. Dit zorgt ervoor dat het gegenereerde project compatibel is met een specifieke archetype versie. LATEST selecteert de meest recente beschikbare versie. |
groupId | Namespace voor het project. |
artifactId | Specificeert de naam van het gegenereerde project. Dit wordt de naam van het resulterende artefact en de projectmap. |
version | Definieer projectversie: MAJOR.MINOR-SNAPSHOT, bijv. 1.0-SNAPSHOT |
flavor | Selecteert een projectvariant:
|
appName | Optionele parameter voor het POM-bestand; kan dienen als standaardtitel voor de applicatie, afhankelijk van het gebruikte webforJ-archetype. |
Na het uitvoeren van het commando zal Maven de benodigde projectbestanden genereren om het project uit te voeren.
De app uitvoeren
Voordat je je app uitvoert, installeer je de vereisten als je dit nog niet hebt gedaan.
Navigeer vervolgens naar de hoofdmap van het project en voer de volgende opdracht uit:
# voor standaard webforj-app
mvn jetty:run
# voor webforj + Spring Boot
mvn spring-boot:run
Zodra de server draait, open je je browser en ga je naar http://localhost:8080 om de app te bekijken.
Voor informatie over het watermerk dat aanwezig is in ongecertificeerde projecten, zie Licentie en Watermerk.