Architecture - SaigoNoo/GetTheBeer GitHub Wiki

Résumé coaching 3

+ Le groupe montre en démo que backend et frontend choisis sont installés et fonctionnent (au moins les bases).
+ Idéalement le groupe peut également faire le lien pour accéder à la base de données choisie.

+ Le groupe explique dans le wiki quelle est l'architecture et comment le projet est mis en place.
+ Le groupe doit maintenir à jour cette partie au fur et à mesure de l'avancement du projet et des choix effectués, en prévenant le coach.
+ Le schéma DB, ainsi que les autres schémas utiles, seront placés ici (datés!) Et mis à jour au fur et à mesure des changements.

1. Backend

1.1 Organisation du code

  • api
    Contient les routes ou endpoints de l’API, organisés par fonctionnalité (backend, user...).

  • classes
    Contient les classes en fichiers py de database, mail, users, etc,....

  • database_init
    Regroupe les scripts d’initialisation ou de migration de la base de données (création des tables, peuplement initial...).

  • mail_templates
    Contient les modèles d’e-mails utilisés pour les notifications envoyées par le backend (confirmation de compte, réinitialisation de mot de passe).

  • Fichiers de configuration

    comprend entre autre main.py, fichier principal qui lance l’application backend.

1.2 Diagramme de classes UML

[Diagramme de classes] [Explication textuelle du diagramme de classes]

2. Schémas, diagrammes et infos

2.1 Diagrammes liés à la base de données

[Schémas EA / Relationnel de la DB] [Texte expliquant les diagrammes et justifiant les choix de conception]

2.2 Résumé du fonctionnement général de l'application (idéalement avec un schéma)

2.3 Autres diagrammes de fonctionnement et d'architecture (ou autres informations utiles)

3. Frontend

3.1 Organisation du code

  • public
    Contient vite.svg

  • src
    Répertoire principal du code source de l’application React. Il comprend :

    • components/ : Composants React réutilisables dans l’interface utilisateur.
    • context/ : Fichiers liés à la gestion de l’état global via React Context.
    • fonts/ : Polices personnalisées utilisées dans l’interface.
    • img/ : Images intégrées à l’application.
    • styles/ : Fichiers de styles CSS/SCSS organisés pour une cohérence visuelle globale.

    Contient les fichiers jsx des pages webs ecrites en ReactJS

  • *Fichiers de configuration

3.2 Apparence

image

Nous avons un design plus "raffiné" qu'au départ, plus propre avec des pop-up pour rendre l'expérience plus dynamique.