prjg5 / gmi

Projet GMI (Glossaire Multilingue Informatisé) pour PRJ5

PRJG5 - GMI

Nécessite

• Git 2.17.1
• PHP 7.3.10
• Composer 1.9.0
• Laravel 6.0.4
• PHPUnit 8
• Librairie benSempo/laravels-enum 1.26

Xampp (A faire avant Installation si vous utilisez Xampp)

1. Démarrer Xampp (MySql et Apache)

2. Créer la base de données

Pour cela, vous pouvez ouvrir Xampp et ouvrir phpMyAdmin via le bouton "Admin"

Nommer la base de données "laravel" en utf32_general_ci

Installation

1. Clone le repo

git clone https://github.com/PRJG5/gmi.git

2. Installer les dépendances

composer install

3. Copier les variables d'environnement

cp  .env.example .env

Modifier le fichier .env pour convenir à ses besoins

4. Générer une clef d'encryption

php artisan key:generate

Nettoyer le cache

php artisan cache:clear
php artisan route:cache
php artisan config:clear
php artisan view:clear
composer dump-autoload

Migrations

Pour mettre à jour votre branche voici les étapes à suivre :

1. Aller sur le master et le mettre à jour

   git pull

2. Aller sur votre branch et merge le master avec votre branche

   git merge master

3. Si vous avez certains conflits,vous pouvez les résoudres via VSC,les classes qui posent problèmes sont marquées en bleu Dés que vous avez fini de régler les conflits :

   git commit -m "[message]"

Enfin,il faut mettre a jour le composer et les migrations de votre base de donnée locale

   php artisan migrate:refresh

Pour mettre à jour le master il faut suivre exactement les mêmes étapes que ci-dessus. N'oubliez surtout pas de push le projet après avoir effectué le merge sur la branche master

Base de donnée

Pour faciliter l'aperçu de la base de donnée, je vous demandes de compléter le fichier .mdj a chaque changement de la base de donnée.Pour trouver plus de détail,veuillez consulter le fichier mdj

Actuellement la base de donnée ressemble à ceci :

Liens utiles

• Trello https://trello.com/b/jy7V3IfE/gmi
• FAQ https://poesi.esi-bru.be/mod/wiki/view.php?id=1613

Sonar-cube

1. Clone le projet

2. Télécharger sonarqube-7.8 et sonnar-scanner-cli

3. Installer composer

4. Lancer Xampp (MySql et Apache)

5. Faire l'étape "Xampp"

6. Lancer la commande "composer install"

7. Lancer le serveur Sonar -> StartSonar.bat

8. Aller sur http://localhost:9000

9. Se connecter en -> User : admin -> MDP : admin

10. Créer un nouveau projet nommé GMI

11. Copier la clé genérée grâce au bouton "Analyse"

12. La clé ressemble a ceci : "46c6277f7dab9eac3a981fec7ee4681619d70b25"

13. Remplacer le sonar.projectKey par GMI

14. Rajouter la variable d'environnement vers sonar-scanner.bat -> Exemple : "C:\Sonar\sonar-scanner\bin"

15. Ouvrir sonar-project.properties et remplacer la clé de sonar.login par la nouvelle clé

16. Aller dans C:\xampp\php et ouvrir php.ini (Le fichier de configuration nommé php)

17. Coller à la fin :

    [XDebug] ; Only Zend OR (!) XDebug zend_extension=C:\xampp\php\ext\php_xdebug.dll ; XAMPP and XAMPP Lite 1.7.0 and later come with a bundled xdebug at /php/ext/php_xdebug.dll, without a version number. xdebug.remote_enable=1 xdebug.remote_host=127.0.0.1 xdebug.remote_port=9000 ; Port number must match debugger port number in NetBeans IDE Tools > Options > PHP xdebug.remote_handler=dbgp xdebug.profiler_enable=1 xdebug.profiler_output_dir="C:\sonarqube\temp" xdebug.var_display_max_depth = 10 xdebug.var_display_max_data = 2048

18. Se placer dans le dossier du projet

19. Lancer le client Sonar -> sonar-scanner

20. Sur le localhost:9000, aller dans GMI -> Administration -> PHP et remplacer Default par PSR-2

21. Relancer un sonar-scanner

Laravel

License

The Laravel framework is open-source software licensed under the MIT license.

gmi's Issues

Conventions de codage utilisées

Juste pour être sur, car on a très peu (voire pas) parlé des conventions de codage.
Je suppose que tout le monde va utiliser :

• pour les classes, du Upper Camel Case (aussi connu sous le nom de PascalCase) ex. class PascalCase {}
• pour les variables, du Lower Camel Case ex. $lowerCamelCase

mais pour les requêtes SQL, noms de tables et de colonnes ?

Je propose :

• pour les noms de table et de colonnes, du Snake Case, comme préconisé par Eloquent (Voire la section "Eloquent Model Conventions") ex. snake_case
• pour tous les mots réservés en SQL, des majuscules. ex. SELECT * FROM [...]

Comme ça on reste cohérent sur tout le projet.
Vous en pensez quoi?

N'oubliez pas de mettre bien des commentaires (en anglais) là où nécessaire (dans le case du nom d'une variable, de la raison de la présence d'une variable, de l'explication du nom rôle de classe, etc...)

---

Peut-être aussi essayer d'utiliser un système de doc ? PHPDoc ?
Pas trop différent de la Javadoc, looks good to me.

/**
 * @author
 * @method
 * @param
 * @return
 * @throws
 * @todo
 * @var
 * @version
 */

Renommer "SpeakedLanguage" en "SpokenLanguage"

Le participe passé du verbe "parler" en anglais est "spoken" et pas "speaked".
Merci de refractorer et de corriger ça, ça fait mal aux yeux 😅

Voilà les fichier à refractorer :
Modèle
Contrôleur (commentaire ligne 63)
Migration (nom de la classe)
Test (nom de la classe et variable $speackedLanguage)

Enum Domain et Subdomain en français?

Je viens de voir que les constantes de l'enum Domain et Subdomain sont en français. On n'est pas censé tout programmer en anglais ?

Ca ne serait pas mieux de les mettre en anglais, puisqu'elles (les valeurs) sont quand même traduites dans les fichiers resources ?

Dossier spécifique pour Bootstrap

cc. @43121

Pour rester organisé, je propose de mettre tous les fichiers pour Boostrap et pour Ajax dans des dossiers propres, et pas juste dans le dossier public/css comme c'est le cas maintenant (ajouté dans a223d59).
Je propose de créer les dossiers public/css/bootstrap et public/js/bootstrap.

Ça permettra de reste mieux organisé.

Aussi, la plupart des fichiers de ce dossier peuvent être retirés, car ils ne seront jamais utilisés :

• Les fichier .map sont uniquement utilisé pour le debugger, pas par le navigateur
• Les fichiers de base sont présents en plus des fichiers minifiés.
• Les fichiers individuels sont présents, alors qu'un bundle (fichier rassemblant tous les autres) est aussi présent.

Classes liées à Card

Il y a eu pas mal de problèmes avec la création de classes liées à la classe "Card".

Aussi, un petit oubli dans le code peut vite casser le build,
➡️ donc voilà une liste des choses à faire si vous devez créer une classe liée à la classe "Card".

Allez là voir, même si vous ne devez pas spécialement créer de classe, dans tous les cas ça ne prend que 2 min à lire et ça peut éviter 1h30 de debuggage et une petite engeulade.

---

❓ Pour toute question :

• demandez aux autres qui ont déjà créé leur classe / fait certaines étapes.
• allez voir ce qu'il y a déjà dans le code (j'ai mis des commentaires là où vous devez rajouter votre code)
• Je peux aussi répondre pour tout ce qui concerne la classe "Card" et la vue (fragment).