WildWonderHub (SAE 3.01)

---

WildWonderHub est une application de gestion des visiteurs et des animaux du Zoo de la Palmyre, utilisant principalement le framework Symfony (version 6.3).

Il s'agit ici de la partie API du projet.

Le sujet sur lequel s'appuyer pour la réalisation de cette SAE se trouve ici.

---

Table des matières

• Auteurs du projet
• Outils utilisés
• Guide d'installation
  • Clonage du Projet
  • Installation des Dépendances
  • Configuration de l'Environnemen Local
  • Configuration de la Base de Données
  • Remplir la base de données
  • Démarrage du Projet
• Gestion des Branches et des Commits
• Installation avec Docker
• Troubleshooting
• VM de l'API

---

Auteurs du projet

• Logan Jacotin
• Romain Leroy
• Vincent Kpatinde
• Clément Perrot

---

Outils utilisés

• Symfony
• API Platform
• Docker

(... à compléter)

---

Guide d'installation

Clonage du Projet

git clone https://iut-info.univ-reims.fr/gitlab/perr0112/sae4-01-api.git
cd sae4-01-api

Installation des dépendances

composer install

Configuration de l'environnement local

Créez un fichier d'environnement local :

cp .env .env.local

Configuration de la base de données

Définissez la configuration de la base de données dans .env.local :

DATABASE_URL="mysql://user:password@mysql:3306/dbName?serverVersion=10.11.2-MariaDB&charset=utf8mb4"

DATABASE_URL pour Docker:

DATABASE_URL="mysql://WildWonderHub_user:WildWonderHub_password@db/WildWonderHub_db?serverVersion=10.11.2-MariaDB&charset=utf8mb4"

Remplir la base de données

composer db

Démarrage du projet

composer start

---

Gestion des branches et des commits

Création d'une nouvelle branche

git checkout -b <nom_de_branche>

Passage à la branche principale

git checkout main
git pull

Rebase et push des modifications

git checkout <nom_de_branche>
git rebase main
git push origin <nom_de_branche>

• Push le code écrit
• Demande de merge request sur le repo gitlab (en décrivant les ajouts/modifications apportés au projet)

Exemple de commit

• Ajout d’une fonctionnalité

git commit -m "add: <fonctionnalité ajoutée>"

• Modification d’une fonctionnalité déjà présente

git commit -m "edit: <fonctionnalité modifiée>"

• Suppression d’un fichier

git commit -m "delete: <fonctionnalité supprimée>"

• Modification d'un composant

git commit -m "edit(<component>): <fonctionnalité modifiée sur le dit component>"

---

Installation avec docker

• Pour le lancer avec le docker compose :

docker-compose up

---

Troubleshooting

Si vous rencontrez des problèmes de permissions, exécutez la commande suivante :

docker exec -ti sae4-01-api-php-1 /bin/sh
chmod -R o+rwx public vendor

---

VM de l'api

Accédez à l'API sur une machine virtuelle utilisant des conteneurs Docker : http://10.31.33.191:8085/api