Changed handling of env var to be able to launch dev with docker comp…

…ose up (will help for compatibility with devContainer
PnX-SI · Jan 13, 2025 · dc395e9 · dc395e9
1 parent 3543de7
commit dc395e9
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 12 deletions.
diff --git a/.env.sample b/.env.sample
@@ -45,3 +45,12 @@ GEONATURE_FRONTEND_PROTOCOL="${BASE_PROTOCOL}"
 GEONATURE_FRONTEND_HOST="${HOST}"
 GEONATURE_FRONTEND_HOSTPORT="${HOSTPORT}"
 GEONATURE_FRONTEND_PREFIX="/geonature"
+
+### DEV CONFIGS  Uncomment if you want to use in dev mode
+# USERSHUB_IMAGE="ghcr.io/pnx-si/usershub-local:latest"
+# GEONATURE_BACKEND_IMAGE="ghcr.io/pnx-si/geonature-backend-local:latest"
+# GEONATURE_BACKEND_EXTRA_IMAGE="ghcr.io/pnx-si/geonature-backend-extra-local:latest"
+# GEONATURE_FRONTEND_IMAGE="ghcr.io/pnx-si/geonature-frontend-local:latest"
+# GEONATURE_FRONTEND_EXTRA_IMAGE="ghcr.io/pnx-si/geonature-frontend-extra-local:latest"
+
+# COMPOSE_FILE=docker-compose.yml:docker-compose-dev.yml
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 SHELL := /bin/bash
 
-prod:
+launch: submodule_init
 	docker compose up -d
 
 submodule_init:
@@ -11,6 +11,11 @@ submodule_init:
 	git submodule update &&\
 	popd
 
-dev: submodule_init
-	build/build.sh
+build: submodule_init
+	buil/build.sh
+
+dev: build
 	docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d
+
+prod: submodule_init
+	 COMPOSE_FILE=docker-compose.yml docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d
diff --git a/README.md b/README.md
@@ -99,6 +99,17 @@ Ces images sont le pendant de [celles publiées sur le dépôt de GeoNature](htt
 
 ## Liens utiles
 
+## Lancer une instance de développement 
+Commencez par vous assurer d'avoir installé make `sudo apt install make`
+
+Il faut ensuite, dans votre fichier .env décommenter les lignes de l'environnent de dev
+
+Une fois cela fait, il ne vous reste plus qu'à lancer `make dev`. Selon vos préférences, si la commande 
+`make submodule_init` a déjà été lancé une fois, vous pouvez simplement lancer un `docker compose up` 
+
+/!\ Attention pour l'instant, l'instance de développement ne lance en mode dev que le backend, pas le frontend ni 
+les autres services. /!\ 
+
 ### GeoNature
 
 - [Dépôt](https://github.com/PnX-SI/GeoNature)

diff --git a/docs/faq.md b/docs/faq.md
@@ -103,15 +103,7 @@ docker image inspect ghcr.io/pnx-si/geonature-backend-extra --format '{{json .Co
 
 - Initialiser et cloner les sous-modules git :
   ```bash
-  git submodule update --init --recursive
-  git submodule update --recursive 
-  ```
-- Faire de même pour les sous-modules de GeoNature et UsersHub, exemple pour GeoNature :
-  ```bash
-  cd sources/GeoNature
-  git submodule init
-  git submodule update
-  cd ../..
+  make submodule_init
   ```
 - Apporter vos éventuelles modifications au code source.
 - Il est conseillé de renommer les images dans le fichier `.env` afin de ne pas rentrer en conflit avec les images officielles, par exemple en leur rajoutant un suffix `-local` :