Skip to content

Commit

Permalink
TD: Add short desc of relations between micro services
Browse files Browse the repository at this point in the history
  • Loading branch information
@Arthi-chaud
Arthi-chaud committed Nov 18, 2023
1 parent 11d098c commit 3998952
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 10 deletions.
18 changes: 9 additions & 9 deletions tech_documentation/db/schema.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@
& username & String, Unique & Nom d’utilisateur \\* \cline{2-4}
& password & String & Hash du mot de passe \\* \cline{2-4}
& email & String & Email de l’utilisateur \\* \cline{2-4}
\multirow{-5}{*}{User} & isGuest & Booléen & Le profil est (ou non) un profil invité. Par défaut: faux \\* \cline{2-4}
\multirow{-5}{0.18\textwidth}{User (\textit{Utilisateurs enregistrés})} & isGuest & Booléen & Le profil est (ou non) un profil invité. Par défaut: faux \\* \cline{2-4}
& partyPlayed & Entier & Nombre de parties jouées. Par défaut: 0 \\* \hline
& id & Entier, Clé Primaire & Identifiant unique \\* \cline{2-4}
& userId & Entier, Unique, Clé étrangère & ID de l’utilisateur associé \\* \cline{2-4}
& pushNotification & Booléen & Autoriser les notifications Push. Par défaut: Vrai \\* \cline{2-4}
& emailNotification & Booléen & Autoriser les notifications par Email. Par défaut: Vrai \\* \cline{2-4}
& trainingNotification & Booléen & Autoriser les notifications d'entraînement. Par défaut: Vrai \\* \cline{2-4}
\multirow{-6}{*}{UserSettings} & newSongNotification & Booléen & Autoriser les notifications lorsqu’une nouvelle chanson est disponible. Par défaut: Vrai \\* \cline{2-4}
\multirow{-6}{0.18\textwidth}{UserSettings (\textit{Preferences des utilisateurs})} & newSongNotification & Booléen & Autoriser les notifications lorsqu’une nouvelle chanson est disponible. Par défaut: Vrai \\* \cline{2-4}
& recommendations & Booléen & Autoriser les recommandations. Par défaut: Vrai \\* \cline{2-4}
& weeklyReport & Booléen & Activer les compte-rendu hebdomadaire. Par défaut: Vrai \\* \cline{2-4}
& leaderBoard & Booléen & Ajouter l'utilisateur aux leaderboards de score. Par défaut: Vrai \\* \cline{2-4}
& showActivity & Booléen & Montrer lorsque l’utilisateur est en ligne. Par défaut: Vrai \\* \hline
& id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
& query & String & Entrée de recherche \\* \cline{2-4}
& type & String ('song', 'artist', 'album' ou 'genre') & Ressource recherchée \\* \cline{2-4}
\multirow{-4}{*}{SearchHistory} & userId & Entier & Identifiant de l’utilisateur qui recherche \\* \cline{2-4}
\multirow{-4}{0.18\textwidth}{SearchHistory (\textit{Historique des recherches})} & userId & Entier & Identifiant de l’utilisateur qui recherche \\* \cline{2-4}
& searchDate & Date & Date de la recherche. Par défaut: Maintenant \\* \hline
\multirow{0}{*}{Song} & id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
\multirow{0}{0.18\textwidth}{Song (\textit{Chansons})} & id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
& name & String & Nom de la chanson \\* \cline{2-4}
& midiPath & String & Chemin (sur le serveur) du fichier MIDI associé \\* \cline{2-4}
& musicXmlPath & String & Chemin (sur le serveur) du fichier MusicXML associé \\* \cline{2-4}
Expand All @@ -42,22 +42,22 @@
& difficulties & JSON & Difficultés associées \\* \hline
& id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
& songID & Entier, Clé étrangère & Identifiant de la chanson unique \\* \cline{2-4}
\multirow{-3}{*}{SongHistory} & userID & Entier, Clé étrangère & Identifiant du joueur \\* \cline{2-4}
\multirow{-3}{0.18\textwidth}{SongHistory (\textit{Preferences des utilisateurs})} & userID & Entier, Clé étrangère & Identifiant du joueur \\* \cline{2-4}
& score & Entier & Score de la partie \\* \cline{2-4}
& info & JSON & Nombre de bonnes, mauvaises notes jouées. \\* \cline{2-4}
& difficulties & JSON & Difficultées rencontrées \\* \cline{2-4}
& playDate & Date & Date de la partie. Par défaut: Maintenant \\* \hline
& id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
\multirow{-2}{*}{Genre} & name & String, Unique & Nom du Genre \\* \hline
\multirow{-1}{*}{Artist} & id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
\multirow{-2}{0.18\textwidth}{Genre (\textit{Genres})} & name & String, Unique & Nom du Genre \\* \hline
\multirow{-1}{0.18\textwidth}{Artist (\textit{Artistes des chansons})} & id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
& name & String, Unique & Nom de l’Artiste \\* \hline
& id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
& name & String, Unique & Nom de la leçon \\* \cline{2-4}
\multirow{-3}{*}{Lesson} & description & String & Description de la leçon \\* \cline{2-4}
\multirow{-3}{0.18\textwidth}{Lesson (\textit{Leçons})} & description & String & Description de la leçon \\* \cline{2-4}
& requiredLevel & Entier & Niveau requis pour jouer la leçln \\* \cline{2-4}
& mainSkill & Enum Skill & Skill principalement étudié dans la leçon \\* \hline
& id & Entier, Clé Primaire & Identifiant Unique \\* \cline{2-4}
\multirow{-2}{*}{LessonHistory} & lessonID & Entier, Clé étrangère & Identifiant de la leçon \\* \cline{2-4}
\multirow{-2}{0.18\textwidth}{LessonHistory (\textit{Preferences des leçons})} & lessonID & Entier, Clé étrangère & Identifiant de la leçon \\* \cline{2-4}
& userID & Entier, Clé étrangère & Identifiant de l'utilisateur \\* \hline
\end{longtable}
\begin{figure}[H]
Expand Down
5 changes: 4 additions & 1 deletion tech_documentation/revisions.tex
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
13-08-2023 & 1.0 & Arthur JAMET & Toutes & Première version \\
30-09-2023 & 1.1 & Arthur JAMET & Toutes & Ajout de l'identité visuelle \\
30-09-2023 & 1.1.1 & Arthur JAMET & Résumé & Réécriture du résumé
18-11-2023 & 1.1.1 & Arthur JAMET & Résumé & Réécriture du résumé \\
18-11-2023 & 1.1.2 & Arthur JAMET & 3.1 & Ajout d'une description pour les tables de la DB
18-11-2023 & 1.1.3 & Arthur JAMET & 2 & Ajout d'une description des relations entre les services


9 changes: 9 additions & 0 deletions tech_documentation/root.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ \section{Structure du projet}
\caption{Les composants du projet et leurs relations}
\end{figure}

La figure 1 illustre les differents composants du projet, ainsi que leurs relations

\begin{itemize}
\item La base de données, accessible uniquement depuis le server.
\item Le server, qui puise et persiste les informations dans/avec la BDD.
\item Le font, qui recupère les informations necessaires (authentication, catalogue, etc.) depuis le server. Il communique egalement avec le scorometer pour calculer en temps réel les scores
\item Le Scorometer, qui donne en temps réel les scores, et les envoie au server pour les sauvegarder.
\end{itemize}

\section{Composants du projet}

\subsection{Base de données}
Expand Down

0 comments on commit 3998952

Please sign in to comment.