Aller au contenu

Travail pratique

ID : A10-TP07.1

But du TP

  • Prendre en main l'IDE IntelliJ IDEA
  • Se familiariser avec l'utilisation du système de gestion de versions Git et la plateforme de gestion de projets GitLab
  • Réaliser collaborativement un site web responsive contenant un formulaire avec HTML et CSS

Travail à réaliser

Site web

  1. Clonez le projet du travail pratique qui se trouve sur GitLab.
  2. Implémentez une page web responsive avec un formulaire en vous basant sur les modèles disponibles sous forme d'images dans le dossier /web/template/img :
    • template-1000px.png : desktop
    • template-768px.png : tablette et smartphone paysage
    • template-480px.png et template-430px.png : smartphone portrait
    • template-with-error-1000px.png : desktop, après une tentative d'envoi du formulaire vide (indicateurs de validation et messages d'erreur, voir Formulaire)
    • Les modèles de chaque largeur d'écran sont aussi visibles dans le navigateur avec la page /web/template/index.html : réduisez la largeur de la fenêtre pour passer d'un modèle à l'autre.
    • Le but est que votre page web, avec un contenu identique, soit similaire (ou le plus proche possible) au modèle en termes de présentation, disposition, agencement, etc.
    • Travaillez dans votre branche feature (voir Workflow Git).

Spécifications

  • Intégrez une police de caractères, non standard (non installée par défaut sur les ordinateurs), de type sans-serif, de votre choix (voir Utilisation en CSS en A08).
    • Les fichiers nécessaires au fonctionnement de la police de caractères doivent être disponibles dans le projet sous /web/font/ dans un dossier portant le nom de la police de caractères.
    • Chaque personne doit utiliser une police de caractères différente de celles des autres.
  • Le header de la page reste visible en haut de la fenêtre lorsque la page défile, sans jamais masquer le contenu (voir Positionnement en A08).
  • Utilisez CSS Grid (voir Grid en A08) pour la mise en page du formulaire et l'aspect Responsive Web Design de celui-ci.
  • Les breakpoints sont ceux des modèles (voir Breakpoints en A09) : ≤768px, ≤480px et ≤430px.
  • Votre page web, votre feuille de style personnelle et toutes les autres ressources (sauf la police de caractères et les ressources communes du projet, ex. /web/img/icon-arrow-down.svg) se trouvent dans un dossier portant le nom d'utilisateur de votre compte HES-SO à la racine du dossier /web.
    • Ex. /web/joel.dacomo (page web index.html)
    • Ex. /web/joel.dacomo/css (feuille de style CSS)
  • Intégrez la feuille de style modern-normalize (qui se trouve sous /web/css/modern-normalize.css), puis la feuille de style commune du site /web/css/main.css (header, footer), dans votre page web (via une balise <link>).
  • Les coins arrondis ont un rayon de 5px.
Formulaire
  • L'ensemble des données du formulaire doit être stocké dans un tableau à clés indexées portant le nom registration-form (ex. name="registration-form[email]", voir Tableaux à clés indexées).
    • Pour les valeurs de l'attribut name des champs du formulaire, référez-vous à la section Données du formulaire.
  • Les valeurs pour les boutons radio "Sexe" sont m pour "Homme" et w pour "Femme".
  • Les valeurs pour la liste déroulante "Etat civil" sont single pour "Célibataire", married pour "Marié(e)", divorced pour "Divorcé(e)", separated pour "Séparé(e)" et widowed pour "Veuf(ve)".
  • Les valeurs pour les cases à cocher "Connaissances en informatique" sont programming pour "Programmation", network pour "Réseau", system pour "Système" et support pour "Support".
  • Les valeurs pour les boutons radio "Orientation envisagée" sont ISC-IL pour "Informatique logicielle", ISC-RS pour "Réseaux et systèmes" et ISC-ID pour "Ingénierie des données".
  • Tous les champs du formulaire sont obligatoires, à l'exception des cases à cocher "Connaissances en informatique" et du champ "Remarque".
    • Le titre de ces deux éléments facultatifs est suivi de la mention "(facultatif)", en texte normal (non gras) de couleur #5c6166.
  • Les champs "Nom", "Prénom", "Localité", "Numéro AVS" et le champ de la rue ("Adresse (en Suisse)") sont de type text.
  • Le champ "Email" est de type email.
  • Le champ "Date de naissance" est de type date et n'accepte pas de date antérieure au 1er janvier 1900.
  • Le champ "NPA" est de type number avec des valeurs comprises entre 1000 et 9999.
  • Le champ "Numéro AVS" doit avoir le format 756.XXXX.XXXX.XX (X doit être un chiffre entre 0 et 9, voir Attribut pattern et expression régulière).
  • Le format attendu du numéro AVS est affiché sous le champ (texte Format : 756.XXXX.XXXX.XX (X = chiffre de 0 à 9), en 14px et de couleur #5c6166), car le placeholder disparaît dès que l'utilisateur commence à écrire.
  • Si le code source reste valide, les champs "Nom", "Prénom", "Email", "Date de naissance", le champ de la rue, "NPA" et "Localité" ont un attribut autocomplete qui indique au navigateur la donnée attendue, pour qu'il puisse remplir le formulaire automatiquement avec les données de l'utilisateur.
  • Un clic sur un label place le focus (l'élément actif de la page, celui qui reçoit les actions du clavier) sur l'élément de formulaire associé (voir Identification des éléments).
    • Ex. : un clic sur le label "Programmation" coche ou décoche la case correspondante, un clic sur le label "Prénom" place le curseur de saisie dans le champ, un clic sur le label "Etat civil" rend la liste active, etc.
  • Les titres "Sexe", "Adresse (en Suisse)", "Connaissances en informatique" et "Orientation envisagée" ne sont pas des labels : chacun de ces groupes de champs est regroupé dans un élément <fieldset>, dont le titre est un élément <legend>.
    • Pourquoi : les outils d'assistance annoncent le titre du groupe avec ses options (ex. "Sexe, Homme, bouton radio", avec chaque option ou une seule fois selon le lecteur d'écran), alors qu'un <label> qui n'est relié à aucun champ n'est annoncé avec aucune option.
    • Le titre d'un groupe a la même apparence que les labels bleus, et la présentation reste identique au modèle : à vous de trouver comment intégrer ces éléments dans la grille du formulaire et comment neutraliser leurs styles par défaut.
    • Sources :
  • Les labels sur lesquels on peut cliquer, le champ "Date de naissance", la liste déroulante "Etat civil" et le bouton "Envoyer" doivent avoir un curseur de type pointer.
  • La bordure des champs du formulaire (sauf les boutons radio et les cases à cocher) est de 1px avec la couleur #868e96 : sur un fond blanc, ce gris assure un contraste suffisant (au moins 3:1) pour bien voir le contour de chaque champ.
  • Les champs de saisie obligatoires (y compris "Date de naissance") et la liste déroulante "Etat civil" ont un indicateur de validation à gauche (bordure de 5px) :
    • gris tant que l'utilisateur n'a pas modifié le champ ni tenté d'envoyer le formulaire : un champ vide n'est donc pas rouge à l'ouverture de la page (voir la remarque sur :user-invalid dans Validation CSS)
    • ensuite, rouge tant que le contenu n'est pas valide et vert lorsque le contenu est valide
  • La couleur seule ne suffit pas à signaler une erreur (une personne daltonienne ne distingue pas forcément le rouge du vert) : quand le contenu d'un champ obligatoire ou d'un groupe obligatoire ("Sexe", "Adresse (en Suisse)", "Orientation envisagée") n'est pas valide, un message d'erreur s'affiche sous celui-ci (ex. "Saisissez votre nom."), en 14px et de couleur #c82333.
    • Textes des messages : voir le modèle template-with-error-1000px.png (un seul message pour le groupe "Adresse (en Suisse)").
    • Le message n'apparaît que lorsque l'indicateur du champ est rouge (pour un groupe de boutons radio : après une tentative d'envoi du formulaire sans option choisie).
    • Chaque message est relié à son champ ou à son groupe avec l'attribut aria-describedby.
    • Source : W3C WAI - Understanding Success Criterion 1.4.1: Use of Color (WCAG 2.2)
  • Les indicateurs de validation et les messages d'erreur sont réalisés uniquement en HTML et CSS, sans JavaScript.
  • Les champs du formulaire (sauf les boutons radio et les cases à cocher) doivent tous être mis en forme via CSS pour avoir la même apparence sur les navigateurs web usuels (testez au moins Chrome, Edge et Firefox, et Safari si vous y avez accès).
  • Le champ de saisie multiligne "Remarque" ne peut être redimensionné par l'utilisateur qu'en hauteur.
  • Les couleurs pour le bouton "Envoyer" et le lien "Retour à l'accueil" sont :
    • Normal : #007cb7
    • Survol (:hover) : #005680
  • Le bouton "Envoyer" a une bordure de 2px avec la couleur #000.
  • La couleur des labels bleus est #007cb7.
  • Les couleurs pour les indicateurs de validation sont :
    • Avant modification du champ ou tentative d'envoi : #868e96
    • Valide : #218838
    • Invalide : #c82333
  • Les champs de saisie du formulaire (sauf "Date de naissance" et "Remarque") ont un texte placeholder (voir Alternative au <label>).
  • La liste "Etat civil" a une option Sélectionnez… non sélectionnable et invalide (au niveau de la validation du formulaire).
  • Tous les champs de saisie (y compris "Date de naissance") et la liste déroulante "Etat civil" ont un padding de 5px en haut et en bas, et de 8px à gauche et à droite.
  • Il y a une marge de 5px entre le champ pour la rue et les champs NPA et localité, ainsi qu'entre les champs NPA et localité.
  • Il y a une marge de 10px entre chaque case à cocher ou bouton radio et son label.
Conteneurs
  • La marge entre les deux conteneurs est de 20px.
  • Le padding des deux conteneurs est de 20px.
  • Le conteneur "Admission" a une couleur de fond #f6f7f8 et une bordure de 1px avec la couleur #d6d8db.
  • Le conteneur du formulaire a un fond blanc et pas de cadre visible, et son contenu reste aligné avec celui du conteneur "Admission".

container-layout.png

Ce qu'il faut regarder

Capture des outils de développement : en orange, la marge de 20px entre les deux conteneurs, en vert, le padding de 20px du conteneur du formulaire, en bleu, son contenu.

CSS Grid
  • La marge entre le titre "Formulaire d'inscription" et la grille des éléments du formulaire est de 40px.
  • L'espacement entre les lignes et entre les colonnes d'éléments, dans la grille, est de 20px (en violet ci-dessous).

form-layout.png

Données du formulaire

  • Pour tester votre formulaire, vous pouvez l'envoyer avec la méthode POST sur la page /web/form-ctrl-test.php.
  • Vous devez obtenir l'affichage suivant avec les données du formulaire :

    form-data.png

    Note

    Cette capture montre l'affichage de var_dump() mis en forme par Xdebug (mode develop). Sans ce mode, les mêmes données s'affichent sans mise en forme : seules les clés et les valeurs comptent.

    Source : Xdebug - Development Helpers

Workflow Git

Utilisez le Feature Branch Workflow pour gérer les versions de votre code source et le partager entre vous : chaque page personnelle est développée dans sa propre branche, puis intégrée à la branche main par une merge request (MR) relue par une autre personne.

  • Respectez l'ensemble des règles, vues en cours, relatives aux messages de commit, aux conventions de nommage des branches et à la numérotation des versions.
  • La branche main est protégée : personne ne peut y faire de push, elle n'est modifiée que par la fusion d'une MR sur GitLab.
  • Une MR ne peut être fusionnée qu'après avoir été approuvée par une autre personne que son auteur (voir Approbation obligatoire).
  • Le projet utilise la méthode de fusion "Merge commit with semi-linear history" : une MR ne peut être fusionnée que si sa branche est à jour par rapport à main (voir Méthodes de fusion dans GitLab).

Organisation

  • Classez les 9 personnes de la classe par ordre alphabétique des noms de famille.
  • Chaque personne relit la MR de la deuxième personne qui la suit dans cette liste (la 1re relit la MR de la 3e, la 2e celle de la 4e… la 8e celle de la 1re et la 9e celle de la 2e) : ce n'est pas la même personne que pour le TP06.
  • Choisissez ensemble la personne responsable de la release 0.5.0 (voir Release ci-dessous), une autre personne que pour les releases 0.5.0 et 0.7.0 du TP06, et communiquez votre choix sur le canal Teams du cours au plus tard le jeudi 19 novembre à 13h.
    • La MR de la release est relue et approuvée par les 8 autres personnes : chacune vérifie que sa ligne figure correctement dans le changelog.

Votre page personnelle

  1. Mettez à jour votre branche main locale, puis créez votre branche feature depuis celle-ci (ex. feature/form-joel.dacomo) :

    git switch main
    git fetch
    git rebase origin/main
    git switch -c feature/form-joel.dacomo
    
  2. Réalisez votre page web dans cette branche, avec des commits réguliers, et envoyez la branche sur origin dès les premiers commits (git push -u origin feature/form-joel.dacomo).

  3. Dans la même branche, une fois la page terminée :
    • Ajoutez un lien vers votre page personnelle dans la liste des formulaires de la page d'accueil du site web /web/index.html, après le lien Template, dans l'ordre alphabétique des noms de famille (ex. Dacomo Joël).
    • Ajoutez une ligne (en anglais) pour votre page dans la section ## [Unreleased] du fichier CHANGELOG.md (voir Changelog).
  4. Sur GitLab, créez une merge request de votre branche vers main :
    • Titre clair et description de votre travail : la description est pré-remplie par le modèle de MR du projet, complétez-la et cochez chaque contrôle effectué.
    • Personne qui relit votre MR dans le champ Reviewer.
    • Option de suppression de la branche source après la fusion cochée, sans regrouper les commits (squash).
  5. Corrigez votre travail selon les commentaires de la relecture, dans de nouveaux commits sur la même branche, puis push : la MR se met à jour automatiquement.
  6. Quand GitLab indique que votre branche n'est plus à jour par rapport à main (une autre MR a été fusionnée entre-temps), mettez-la à jour avec un rebase (voir Mettre à jour la branche) :

    git fetch
    git rebase origin/main
    git push --force-with-lease
    
    • Toutes les MR modifient la liste des formulaires de /web/index.html et la section [Unreleased] de CHANGELOG.md : des conflits sont attendus. Résolvez-les en gardant les lignes des autres et la vôtre, dans l'ordre alphabétique pour la liste des formulaires.
  7. Après la fusion, nettoyez votre dépôt local (voir Nettoyer).

Relecture de la MR d'une autre personne

  1. Récupérez la branche de la MR et testez la page dans votre navigateur (git fetch, puis git switch feature/form-<prénom.nom>).
  2. Contrôlez les points suivants :
    • La page respecte les spécifications de ce document et les modèles
    • Les indicateurs de validation et les messages d'erreur se comportent comme décrit (à l'ouverture de la page, après une saisie valide ou invalide, après une tentative d'envoi du formulaire vide)
    • Les données reçues par /web/form-ctrl-test.php correspondent à l'affichage attendu
    • Le code HTML et CSS respecte le code style, sans erreur signalée par Prettier, Stylelint, le Nu Html Checker et le CSS Validation Service
    • Seuls le dossier personnel de l'auteur, le dossier de sa police de caractères dans /web/font/, sa ligne dans la liste des formulaires de /web/index.html et sa ligne dans CHANGELOG.md sont modifiés (onglet Changes de la MR)
    • Les messages de commit respectent les règles vues en cours
  3. Laissez au moins un commentaire dans la MR (correction demandée, question ou remarque), sur la ligne concernée.
  4. Une fois les corrections faites et toutes les discussions résolues, approuvez la MR (Approve), puis fusionnez-la (Merge) : GitLab bloque la fusion tant que la MR n'a pas été approuvée.
    • Si GitLab bloque la fusion parce que la branche n'est pas à jour, demandez à l'auteur de faire le rebase (étape 6 ci-dessus). N'utilisez pas vous-même le bouton Rebase : les commits réécrits seraient enregistrés à votre nom (committer) et GitLab ne vous autoriserait plus à approuver la MR.

Release

Dès que la 9e et dernière MR des pages personnelles est fusionnée, la personne responsable de la release publie la version 0.5.0, au plus tard le jeudi 19 novembre à 23h59 :

  1. Depuis la branche main à jour, créez la branche release/0.5.0.
    • Ce n'est pas une branche release de Gitflow : c'est une branche courte comme les autres, qui ne contient que la mise à jour du changelog.
  2. Dans CHANGELOG.md, transformez la section ## [Unreleased] en section ## [0.5.0] - <date du jour> (date au format AAAA-MM-JJ), ajoutez une nouvelle section ## [Unreleased] vide au-dessus, faites un commit et push la branche.
  3. Créez une MR vers main et indiquez les 8 autres personnes dans le champ Reviewer.
    • Les contrôles du modèle de MR concernent les pages personnelles : remplacez-les par un résumé de la version.
    • Chaque personne vérifie la MR, en particulier sa ligne dans le changelog, puis l'approuve (Approve).
    • Fusionnez-la vous-même (Merge) uniquement une fois qu'elle a été approuvée par les 8 autres personnes (liste Approved by de la MR).
    • GitLab autorise la fusion dès la première approbation : c'est à vous d'attendre les 8. Une seule approbation manquante retarde donc la release : assurez-vous que chacun est disponible pour l'approuver avant l'échéance.
  4. Après la fusion, créez le tag annoté v0.5.0 sur le dernier commit de main et envoyez-le sur origin (voir Tags).
  5. Sur GitLab, créez la release v0.5.0 à partir de ce tag (Deploy → Releases → New release), avec les notes de version reprises du changelog.

A la fin du travail pratique, seule la branche main doit exister sur origin (plus de branches feature ou release), avec le tag v0.5.0 et la release GitLab correspondante.

🚨 Aucun merge local dans main : toutes les fusions se font sur GitLab, par une merge request relue.

  • Evitez de faire un pull afin de ne pas générer de merge inutile : utilisez fetch puis rebase.
  • Le push forcé (git push --force-with-lease) est autorisé uniquement sur votre propre branche feature, après un rebase. Jamais sur une branche sur laquelle quelqu'un d'autre travaille.
  • Utilisez "interactive rebase" pour repositionner, modifier ou arranger vos commits dans votre branche feature, si besoin, de préférence avant de demander la relecture.
  • Pour corriger une erreur ou un oubli dans le code déjà fusionné dans main, créez une branche fix/… depuis main et une nouvelle MR (voir Corrections).
  • Organisez-vous entre vous pour que tout soit terminé à temps : relectures, corrections, rebase, fusions et release prennent du temps. Ouvrez votre MR (éventuellement en brouillon) dès que possible.

Mise en production

  1. Déployez la dernière version du site web (le dossier /web du projet) sur votre serveur de production (VPS) avec l'URL https://tp07.apiXX.isc.heia-fr.ch (remplacez XX par le numéro de votre serveur personnel).
    • La page d'accueil de nginx doit bien évidemment rester accessible avec l'URL https://apiXX.isc.heia-fr.ch.
    • Le site web fait avec MkDocs doit aussi rester accessible avec l'URL https://tp05.apiXX.isc.heia-fr.ch.
    • Le site web du blog doit aussi rester accessible avec l'URL https://tp06.apiXX.isc.heia-fr.ch.
    • Par "dernière version du site web", on entend la version 0.5.0 (tag v0.5.0 de la branche main), avec les 9 pages personnelles.

Lighthouse

Lighthouse est l'outil d'analyse de pages web intégré à Chrome (onglet Lighthouse des outils de développement). Il attribue à la page un score de 0 à 100 par catégorie : rouge de 0 à 49, orange de 50 à 89, vert de 90 à 100.

  1. Votre page personnelle, en production sur votre VPS (https://tp07.apiXX.isc.heia-fr.ch/<prénom.nom>/), obtient un score vert (de 90 à 100) dans chacune des 4 catégories Performance, Accessibility, Best Practices et SEO.
    • Lancez l'analyse en mode Navigation, avec l'appareil Mobile, dans une fenêtre de navigation privée (les extensions du navigateur faussent les résultats).
    • La catégorie expérimentale Agentic Browsing, si elle est affichée, n'est pas concernée (elle ne donne pas de score de 0 à 100).
    • Le score de la catégorie Performance varie d'une analyse à l'autre : lancez-la plusieurs fois.
  2. Analysez votre page en local avant de demander la relecture de votre MR, et corrigez les problèmes signalés : après la release, une correction du code demande une nouvelle MR et une nouvelle version.
    • En production, d'autres problèmes peuvent apparaître (ex. erreurs dans la console dues à la CSP de votre serveur) : corrigez-les dans la configuration de nginx, sans modifier le code du site.

Source : Chrome for Developers - How Lighthouse calculates your overall Performance score


Rendu du TP

Aucun rapport, manuel ou documentation n'est demandé pour ce travail pratique.

Echéances :

  • Jeudi 19 novembre à 13h : le nom de la personne responsable de la release (une autre personne que pour les releases du TP06) est communiqué sur le canal Teams du cours.
  • Jeudi 19 novembre à 23h59 : toutes les MR sont fusionnées et la version 0.5.0 est publiée (tag v0.5.0 et release GitLab) par la personne responsable de la release.
  • Vendredi 20 novembre à 23h59 : chaque personne a mis en ligne la version 0.5.0 du site web sur son VPS.

Le TP sera évalué, entre autres, sur les critères suivants :

  • Respect de toutes les consignes de ce document
  • Utilisation correcte du Feature Branch Workflow (branche, merge request, mise à jour par rebase, fusion sur GitLab)
  • Relecture de la MR d'une autre personne : commentaires pertinents, approbation et fusion
  • Commits respectant les règles vues ensemble
  • Mises à jour correctes et pertinentes du changelog
  • Numérotation correcte des versions, tag et release GitLab
  • Disponibilité de la dernière version du site web sur votre VPS
  • Code source de qualité respectant tous les thèmes vus durant le cours
  • Résultat visuel identique ou le plus proche possible des modèles