Installation locale

Ouvrir dans ChatGPT

Cette section de la documentation couvrira les étapes nécessaires uniquement pour les utilisateurs qui souhaitent utiliser webforJ pour le développement web et/ou d'applications avec une instance BBj locale sur leur machine. Cette installation ne permettra pas aux utilisateurs de contribuer au code de la fondation webforJ.

info

Ce guide couvrira l'installation sur un système Windows - les étapes d'installation peuvent varier pour les appareils Mac/Linux.

L'installation sera décomposée en plusieurs étapes :

1. Téléchargement et installation de BBj
2. Utilisation du Gestionnaire de plugins BBj pour créer votre application
3. Lancement de votre application

Prérequis

Avant de commencer, assurez-vous d'avoir examiné les prérequis nécessaires pour configurer et utiliser webforJ. Cela garantit que vous disposez de tous les outils et configurations requis avant de commencer votre projet.

1. Téléchargement et installation de BBj

En suivant cette étape, assurez-vous d'installer la version de BBj qui correspond à la même version de webforJ.

Cette vidéo peut vous aider avec l'installation de BBj si vous avez besoin d'assistance pour la configuration. La section d'installation du site web de BASIS se trouve à ce lien.

conseil

Il est recommandé d'utiliser la dernière version stable de BBj et de sélectionner "BBj" dans la liste des options, sans Barista ni Addon.

2. Installer et configurer le plugin webforJ

Une fois BBj installé, le Gestionnaire de plugins peut être accessible pour installer les outils nécessaires à la configuration de webforJ. Pour commencer, tapez "Plugin Manager" dans le menu démarrer ou Finder.

Après avoir ouvert le gestionnaire de plugins, accédez à l'onglet "Plugins disponibles" en haut.

Une fois dans cette section, sélectionnez la case à cocher "Afficher les versions en développement".

L'entrée DWCJ devrait maintenant être visible dans la liste des plugins disponibles à télécharger. Cliquez sur cette entrée dans la liste pour la sélectionner.

Avec l'entrée DWCJ sélectionnée, cliquez sur le bouton "Installer".

Une fois le plugin installé, cliquez sur l'onglet "Plugins installés" en haut.

Cet onglet affiche les plugins installés, qui devraient maintenant inclure l'entrée DWCJ. Cliquez sur l'entrée dans la liste.

Avec l'entrée DWCJ sélectionnée, cliquez sur le bouton "Configurer".

Dans la fenêtre qui s'ouvre, cliquez sur le bouton "Activer l'installation Maven à distance" en bas à gauche de la fenêtre.

conseil

Alternativement, accédez au répertoire bin dans votre dossier bbx et exécutez la commande suivante :

./bbj -tIO DWCJ/cli.bbj - enable_remote_install

Une boîte de dialogue doit s'afficher indiquant que l'installation à distance a été activée. Cliquez sur "OK" pour fermer cette boîte de dialogue.

3. Utiliser le projet de démarrage

Une fois BBj et le plugin webforJ requis installés et configurés, vous pouvez créer un nouveau projet structuré à partir de la ligne de commande. Ce projet contient les outils nécessaires pour exécuter votre premier programme webforJ.

Pour créer et mettre en place un nouveau projet bbj-hello-world, suivez ces étapes :

1. Naviguez vers le répertoire approprié: Ouvrez un terminal et déplacez-vous dans le dossier où vous souhaitez créer votre nouveau projet.
2. Exécuter la commande archetype:generate: Utilisez la commande Maven ci-dessous et personnalisez le groupId, l'artifactId et la version selon les besoins de votre projet.

Bash/Zsh

mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-bbj-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-DappName=MyApp

PowerShell

mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-DappName="MyApp"

Command Prompt

mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-DappName="MyApp"

Argument	Explication
archetypeGroupId	L'ID de groupe de l'archétype est com.webforj pour les archétypes webforJ.
archetypeArtifactId	Spécifie le nom de l'archétype à utiliser.
archetypeVersion	Spécifie la version de l'archétype à utiliser. Cela garantit que le projet généré est compatible avec une version d'archétype spécifique. Utiliser LATEST sélectionne la version la plus récente disponible.
groupId	Représente l'espace de nom du projet généré. Généralement structuré comme un package Java, par exemple org.example, et est utilisé pour identifier de manière unique votre organisation ou domaine de projet.
artifactId	Spécifie le nom du projet généré. Ce sera le nom de l'artifact résultant et du dossier du projet.
version	Définit la version du projet généré. Une convention courante est MAJOR.MINOR-SNAPSHOT, comme 1.0-SNAPSHOT, où SNAPSHOT indique que le projet est encore en développement.
appName	Un paramètre optionnel pouvant être utilisé dans le fichier POM du projet généré. Selon l'archétype webforJ utilisé, il peut servir de titre par défaut pour l'application.

Après l'exécution de la commande, Maven générera les fichiers de projet nécessaires pour exécuter le projet.

4. Lancement de l'application

Une fois cela fait, exécutez un mvn install dans votre répertoire de projet. Cela exécutera le plugin d'installation webforJ et vous permettra d'accéder à votre application. Pour voir l'application, vous devez vous rendre à l'URL suivante :

http://localhost:YourHostPort/webapp/YourPublishName

Remplacez YourHostPort par le port d'hôte que vous avez configuré avec Docker, et YourPublishName est remplacé par le texte à l'intérieur de la balise <publishname> du POM. Si tout a été fait correctement, vous devriez voir le rendu de votre application.