ClimWeb Documentation
Exécuter l’environnement de développement¶
Si vous souhaitez contribuer à Climweb, vous devez configurer l’environnement de développement sur votre ordinateur local. La meilleure façon de procéder est d’utiliser Docker Compose afin que vous puissiez démarrer l’application avec le moins de tracas possible.
Note
Pour le déploiement en production, veuillez visiter https://github.com/wmo-raf/climweb-docker
Clonage du référentiel¶
La première étape consiste à cloner le référentiel Climweb depuis GitHub. Vous pouvez le faire en exécutant la commande suivante dans votre terminal :
$ git clone https://github.com/wmo-raf/climweb.git
$ cd climweb
Créer un fichier .env¶
Ensuite, vous devez créer un fichier d’environnement contenant la configuration nécessaire pour l’environnement de développement. Vous pouvez le faire en copiant l’exemple de fichier d’environnement de développement fourni dans le référentiel :
$ cp .env.dev.sample .env
Mettez à jour le fichier .env avec la configuration requise. Consultez la section Variables d’environnement pour référence sur les variables d’environnement disponibles et leurs descriptions.
Démarrage rapide¶
Si vous êtes familier avec git et Docker Compose, exécutez ces commandes pour lancer l’environnement de développement de Climweb localement, sinon veuillez commencer par la section Conditions d’installation ci-dessous.
$ git clone https://github.com/wmo-raf/climweb.git
# Our supplied ./dev.sh script wraps Docker Compose setting the correct env vars for
# you to get hot code reloading working well.
$ ./dev.sh
# Run ./dev.sh help for further details.
$ ./dev.sh help
Exigences d’installation¶
Si vous n’avez pas encore installé Docker et Docker Compose sur votre ordinateur, vous pouvez le faire en suivant les instructions sur https://docs.docker.com/desktop et https://docs.docker.com/compose/install
Note
Docker version 19.03 est le minimum requis pour construire Climweb. Il est cependant fortement conseillé d’installer la dernière version de Docker disponible. Veuillez vérifier que votre docker est à jour en exécutant docker -v.
Vous aurez également besoin d’installer git, ce que vous pouvez faire en suivant les instructions sur https://www.linode.com/docs/development/version-control/how-to-install-git-on-linux-mac-and-windows.
Une fois que vous avez terminé d’installer tous les logiciels requis, vous devriez pouvoir exécuter les commandes suivantes dans votre terminal.
$ docker -v
Docker version 28.1.1, build 4eba377
$ docker compose version
Docker Compose version v2.35.1-desktop.1
$ git --version
git version 2.37.1
Si toutes les commandes renvoient quelque chose de similaire à celui décrit dans l’exemple, alors vous êtes prêt à continuer !
Démarrage de l’environnement de développement¶
Tout d’abord, vous devez cloner le référentiel. Exécutez les commandes suivantes pour cloner la branche principale. Si vous n’êtes pas familier avec git clone, cela téléchargera une copie du code de Climweb sur votre ordinateur.
$ git clone https://github.com/wmo-raf/climweb.git
Cloning into 'climweb'...
...
$ cd climweb
Maintenant que nous avons notre copie du dépôt et que nous avons changé les répertoires vers le climweb nouvellement créé, nous pouvons afficher les conteneurs.
Si vous ne souhaitez pas utiliser le script dev.sh fourni, vous pouvez exécuter la commande suivante pour démarrer l’environnement de développement :
$ docker compose -f docker-compose.yml -f docker-compose.dev.yml up
Note
Notez que le fichier « docker-compose.dev.yml » est utilisé pour remplacer le fichier « docker-compose.yml » par défaut avec des paramètres spécifiques au développement.
Accéder à l’application Web¶
Une fois les conteneurs opérationnels, vous pouvez accéder à l’application Climweb dans votre navigateur Web à l’adresse http://localhost:8000. Le port peut être modifié dans le fichier .env si nécessaire en modifiant la variable CLIMWEB_DEV_PORT.
Créer un superutilisateur¶
Pour créer un superutilisateur pour l’application Climweb, vous pouvez exécuter la commande suivante dans une fenêtre de terminal séparée :
$ docker compose -f docker-compose.yml -f docker-compose.dev.yml exec climweb climweb createsuperuser
Gardez le conteneur en marche¶
Les conteneurs doivent continuer à fonctionner pendant que vous développez. Ils surveillent également les modifications des fichiers et se mettent à jour automatiquement, vous n’avez donc pas à vous soucier du rechargement. Toute modification du code déclenchera un rechargement et vous pourrez voir les modifications immédiatement.