From 5cca0f09933c17f58c3899a2ce9f69226719d77c Mon Sep 17 00:00:00 2001 From: Eliott Schott <eliott.schott.eliott@gmail.com> Date: Thu, 3 Apr 2025 16:28:54 +0200 Subject: [PATCH] update readme with faq and updated prise en main --- Compte_rendu.md | 67 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 55 insertions(+), 12 deletions(-) diff --git a/Compte_rendu.md b/Compte_rendu.md index 20120b5..b47ac44 100644 --- a/Compte_rendu.md +++ b/Compte_rendu.md @@ -62,36 +62,75 @@ Rendez-vous là où vous avez cloné le projet (web et API) et, dans chacun des docker-compose -f docker-compose.prod.yml up -d ``` +Pour vérifier si les conteneurs sont bien lancés, effectuer la commande + +``` +docker ps +``` + # FAQ +Les conteneurs ne démarrent pas après docker-compose up -d : + +- Vérifier les logs avec docker-compose logs -f +- Vérifier si les ports sont déjà utilisés (netstat -tulnp | grep LISTEN) +- Vérifier que docker et docker-compose sont bien installés + +Problème de permissions en executant docker-compose up : + +- Effectuer la commande + +``` +sudo usermod -aG docker $USER +``` + +- Se déconnecter puis se reconnecter + # Prise en main +Lors de la réception du projet, nous n'avons pas trouvé de procédure d'installation. Nous avons donc peu parcouru les différents projets, et avons trouvé +deux fichiers docker-compose permettant de déployer respectivement l'API et l'application Web (comme précisé dans la documentation d'installation ci dessus). +Nous avons donc repris ces fichiers pour déployer les applications. + +Nous n'avons également pas trouvé de foire aux questions ni de troubleshooting. + +Le pipeline est fonctionnel, mais a necessité la modification de l'adresse de déploiement sans trop de surprise (la modification a été très rapide). + ## Technologies -L'api utilise des technos vu en cours (prisma, express, jwt, etc) ou utilisé dans nos anciens projet (swagger, etc). L'extension et la maintanbilité ne devrait pas poser trop de problème. +L'api utilise des technos vues en cours (prisma, express, jwt, etc) ou utilisées dans nos anciens projet (swagger, etc). L'extension et la maintanbilité ne devraient pas poser trop de problèmes. ## Ancien protocole d'installation Au besoin, les bribes de documentation et infos transmises par l'ancien groupe en charge du développement de Gyokereske sont disponibles [ici](https://git.unistra.fr/jagermasters/gyokeres-deploy-assistance/-/blob/main/Ancien%20protocole.md?ref_type=heads). Nous y avons ajouté un guide de création d'APK pour distribuer l'application mobile. -## Problèmes repérés +## Problèmes techniques -- Interface web pas responsive -- Clignotement du "Back to Home" - Joueur parfois kické des quiz de manière random après une question (quand plusieurs ont la même bonne réponse en même temps, on dirait) -- Logo sous licence -- Pas de média -- Une note beaucoup trop haute pour un projet à moitié terminé -- L'interface pour rejoindre est nulle (aucun style CSS) -- Sign-up : si jamais on crée un compte avec un nom déjà utilisé, ça nous dit juste "Création du compte impossible" ou "Invalid credentials" -- Il n'y a pas de média - QR code envoie vers localhost - Parfois, l'application fail de manière aléatoire -- Le style de la modal pour rejoindre est affreux, c'est du natif HTML sans CSS - Modes multi ont une connexion instable - Modes multi sont affreusement lents (problème d'ergonomie, long à redévelopper) - Dans la CI/CD, les tests et le lint ne marchent pas, dans le sens où ils sont mal configurés et il manque des dépendances +## Problèmes UI/UX + +- Interface web pas responsive +- Clignotement du "Back to Home" +- L'interface pour rejoindre est nulle (aucun style CSS) +- Sign-up : si jamais on crée un compte avec un nom déjà utilisé, ça nous dit juste "Création du compte impossible" ou "Invalid credentials" +- Le style de la modal pour rejoindre est affreux, c'est du natif HTML sans CSS + +## Problèmes liés aux ressources et contenus + +- Logo sous licence +- Pas de média +- Il n'y a pas de média + +## Problèmes divers + +- Une note beaucoup trop haute pour un projet à moitié terminé + # Notes complémentaires ## Interactions inter-équipes @@ -117,8 +156,12 @@ Enfin, et cette fois pour être plus taquin, je précise que le groupe qui nous -- Samuel +On n'est pas venu me demander d'aide pour déployer mon ancienne application (Mogula). On a plutôt demandé a Mathieu Ackermann, qui s'est occupé intégralement du déploiement en collaboration avec Louis Schlegel. + +-- Eliott + ## Configuration de Docker -Le script de lancement du groupe Gyokereske apporte une configuration spécifique à Docker tout en "forçant" l'utilisateur à être sur une machine Linux. +Le script de lancement du groupe Gyokeres apporte une configuration spécifique à Docker tout en "forçant" l'utilisateur à être sur une machine Linux. Autant la deuxième anomalie est réglable en précisant une image Docker basée sur Linux (ex : les versions "Alpine" des images X ou Y), autant la première a perturbé le projet d'alternance et provoqué plusieurs heures de debug sur un projet qui n'avait pourtant rien à voir... -- GitLab