Getting Started

Abrir en ChatGPT

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

Requisitos previos

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

Usando startforJ

La forma más sencilla de crear una nueva aplicación webforJ es a través de startforJ, que genera un proyecto de inicio mínimo basado en un archetype de webforJ elegido. Este proyecto de inicio incluye todas las dependencias requeridas, archivos de configuración y un diseño predefinido, por lo que puedes 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 Aplicación, ID de Grupo, ID de Artefacto)
• versión de webforJ y versión de Java
• Color y Icono del Tema
• Archetype
• Sabor

Hay dos opciones de sabor para elegir, siendo "webforJ Only" la predeterminada:

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

Soporte para Spring Boot

El sabor de Spring Boot solo está disponible en la versión 25.02 y superior de webforJ. Si seleccionas esta opción, asegúrate de elegir una versión compatible.

Archetypes disponibles

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

Con esta información, startforJ crearás un proyecto básico de tu archetype elegido 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 continúa con ejecutando la aplicación.

Usando la línea de comandos

Si prefieres utilizar la línea de comandos, puedes generar un proyecto directamente utilizando el archetype de Maven:

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

1. Navegar al directorio adecuado: Abra una terminal y muévase a la carpeta donde desea crear su nuevo proyecto.
2. Ejecutar el comando archetype:generate: Use el comando Maven a continuación y personalice groupId, artifactId y version según sea necesario para su 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 de grupo del arquetipo es com.webforj para arquetipos webforJ.
archetypeArtifactId	Especifica el nombre del arquetipo a usar.
archetypeVersion	Especifica la versión del arquetipo a usar. Esto garantiza 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 Java, como org.example, y se usa 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 MAJOR.MINOR-SNAPSHOT, como 1.0-SNAPSHOT, donde SNAPSHOT indica que el proyecto aún está en desarrollo.
flavor	Selecciona una variante del proyecto: webforj - Aplicación webforJ estándar. webforj-spring - Aplicación webforJ con soporte 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, puede utilizarse 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.

Ejecutando la aplicación

Antes de ejecutar tu aplicación, instala los requisitos previos si aún no lo has hecho.
Luego, navega al directorio raíz del proyecto y ejecuta el siguiente comando:

# para una aplicación estándar de webforj  
mvn jetty:run  

# para webforj + Spring Boot  
mvn spring-boot:run  

Una vez que el servidor esté en funcionamiento, abre tu navegador y ve a http://localhost:8080 para ver la aplicación.

Licencias y marca de agua

Para información sobre la marca de agua presente en proyectos no licenciados, consulta Licencias y Marca de Agua.