Getting Started

Abrir en ChatGPT

Este artículo describe los pasos para crear una nueva aplicación webforJ utilizando los arquetipos de webforJ. Los arquetipos proporcionan estructuras de proyecto preconfiguradas y código inicial para que puedas poner un proyecto en marcha rápidamente. Para crear una nueva aplicación webforJ a partir de un arquetipo, puedes usar startforJ o la línea de comandos.

Requisitos previos

Antes de comenzar, revisa los requisitos previos necesarios para configurar y utilizar webforJ.

Usando startforJ

La forma más sencilla de crear una nueva aplicación webforJ es startforJ, que genera un proyecto base mínimo basado en un arquetipo webforJ elegido. Este proyecto inicial incluye todas las dependencias requeridas, archivos de configuración y un diseño prehecho, para que puedas comenzar a construir sobre él de inmediato.

Personalizando con startforJ

Cuando creas una aplicación con startforJ, puedes personalizarla proporcionando la siguiente información:

• Metadatos básicos del proyecto (Nombre de la app, ID del grupo, ID del artefacto)
• Versión de webforJ y versión de Java
• Color y icono del tema
• Arquetipo
• Sabor

Hay dos opciones de sabor para elegir, siendo "Solo webforJ" la opción predeterminada:

• Solo webforJ: Aplicación estándar de webforJ
• webforJ + Spring Boot: Aplicación de webforJ con soporte de Spring Boot

Arquetipos disponibles

webforJ viene con varios arquetipos predefinidos para ayudarte a comenzar rápidamente. Para obtener una lista completa de los arquetipos disponibles, consulta el catálogo de arquetipos.

Usando esta información, startforJ creará un proyecto básico a partir del arquetipo que elijas con tus personalizaciones seleccionadas. Puedes optar por descargar tu proyecto como un archivo ZIP o publicarlo directamente en GitHub.

Una vez que hayas descargado tu proyecto, abre la carpeta del proyecto en tu IDE y pasa a ejecutar la aplicación.

Usando la línea de comandos

Si prefieres usar la línea de comandos, puedes generar un proyecto directamente usando el arquetipo de Maven:

Para crear y estructurar un nuevo proyecto hello-world, sigue estos pasos:

1. Navegar al directorio adecuado: Abre una terminal y muévete a la carpeta donde deseas crear tu nuevo proyecto.
2. Ejecutar el comando archetype:generate: Utiliza el comando Maven a continuación y personaliza el groupId, artifactId y versión según sea necesario para tu proyecto.

Bash/Zsh

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

PowerShell

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"

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"

Argumento	Explicación
archetypeGroupId	El ID del grupo del arquetipo es com.webforj para los arquetipos de webforJ.
archetypeArtifactId	Especifica el nombre del arquetipo a usar.
archetypeVersion	Especifica la versión del arquetipo a utilizar. Esto asegura que el proyecto generado sea compatible con una versión específica del arquetipo. Usar LATEST selecciona la versión más reciente disponible.
groupId	Representa el espacio de nombres para el proyecto generado. Típicamente estructurado como un paquete de Java, como org.example, y se utiliza para identificar de manera única su organización o dominio del proyecto.
artifactId	Especifica el nombre del proyecto generado. Este será el nombre del artefacto resultante y la carpeta del proyecto.
version	Define la versión del proyecto generado. Una convención común es MAYOR.MENOR-SNAPSHOT, como 1.0-SNAPSHOT, donde SNAPSHOT indica que el proyecto aún está en desarrollo.
flavor	Seleccionar un sabor de proyecto: webforj - Aplicación estándar de webforJ. webforj-spring - Aplicación webforJ con soporte para Spring Boot (requiere webforJ 25.02 o superior).
appName	Un parámetro opcional que se puede usar en el archivo POM del proyecto generado. Dependiendo del arquetipo webforJ utilizado, se puede utilizar como título predeterminado para la aplicación.

Después de ejecutar el comando, Maven generará los archivos del proyecto necesarios para ejecutar el proyecto.

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

Full maven command

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.