Describe the technologies used, draft out parts

main
Shad Amethyst 2 years ago
parent 625f7910d6
commit 4c8b656b86

@ -37,3 +37,5 @@ make
## Licensing
The gitlab logo belongs to GitLab and is used in accordance to its [license](https://gitlab.com/gitlab-org/gitlab-svgs/-/blob/main/LICENSE).
The typescript logo belongs to Microsoft and is used under the guidelines set out on the [typescript branding page](https://www.typescriptlang.org/branding/).

@ -0,0 +1 @@
<svg fill="none" height="128" viewBox="0 0 128 128" width="128" xmlns="http://www.w3.org/2000/svg"><rect fill="#3178c6" height="128" rx="6" width="128"/><path clip-rule="evenodd" d="m74.2622 99.468v14.026c2.2724 1.168 4.9598 2.045 8.0625 2.629 3.1027.585 6.3728.877 9.8105.877 3.3503 0 6.533-.321 9.5478-.964 3.016-.643 5.659-1.702 7.932-3.178 2.272-1.476 4.071-3.404 5.397-5.786 1.325-2.381 1.988-5.325 1.988-8.8313 0-2.5421-.379-4.7701-1.136-6.6841-.758-1.9139-1.85-3.6159-3.278-5.1062-1.427-1.4902-3.139-2.827-5.134-4.0104-1.996-1.1834-4.246-2.3011-6.752-3.353-1.8352-.7597-3.4812-1.4975-4.9378-2.2134-1.4567-.7159-2.6948-1.4464-3.7144-2.1915-1.0197-.7452-1.8063-1.5341-2.3598-2.3669-.5535-.8327-.8303-1.7751-.8303-2.827 0-.9643.2476-1.8336.7429-2.6079s1.1945-1.4391 2.0976-1.9943c.9031-.5551 2.0101-.9861 3.3211-1.2929 1.311-.3069 2.7676-.4603 4.3699-.4603 1.1658 0 2.3958.0877 3.6928.263 1.296.1753 2.6.4456 3.911.8109 1.311.3652 2.585.8254 3.824 1.3806 1.238.5552 2.381 1.198 3.43 1.9285v-13.1051c-2.127-.8182-4.45-1.4245-6.97-1.819s-5.411-.5917-8.6744-.5917c-3.3211 0-6.4674.3579-9.439 1.0738-2.9715.7159-5.5862 1.8336-7.844 3.353-2.2578 1.5195-4.0422 3.4553-5.3531 5.8075-1.311 2.3522-1.9665 5.1646-1.9665 8.4373 0 4.1785 1.2017 7.7433 3.6052 10.6945 2.4035 2.9513 6.0523 5.4496 10.9466 7.495 1.9228.7889 3.7145 1.5633 5.375 2.323 1.6606.7597 3.0954 1.5486 4.3044 2.3668s2.1628 1.7094 2.8618 2.6736c.7.9643 1.049 2.06 1.049 3.2873 0 .9062-.218 1.7462-.655 2.5202s-1.1 1.446-1.9885 2.016c-.8886.57-1.9956 1.016-3.3212 1.337-1.3255.321-2.8768.482-4.6539.482-3.0299 0-6.0305-.533-9.0021-1.6-2.9715-1.066-5.7245-2.666-8.2591-4.799zm-23.5596-34.9136h18.2974v-11.5544h-51v11.5544h18.2079v51.4456h14.4947z" fill="#fff" fill-rule="evenodd"/></svg>

After

Width:  |  Height:  |  Size: 1.7 KiB

@ -104,3 +104,66 @@
howpublished="\url{https://nx.dev/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{bun,
title={Bun - fast all-in-one Javascript runtime},
author={Bun},
howpublished="\url{https://bun.sh/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{typescriptlogo,
title={TypeScript: Branding},
author={Microsoft},
howpublished="\url{https://www.typescriptlang.org/branding/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{typescript,
title={TypeScript: Javascript with syntax for types},
author={Microsoft},
howpublished="\url{https://www.typescriptlang.org/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{react,
title={React - A Javascript library for building user interfaces},
author={Facebook Open Source},
howpublished="\url{https://reactjs.org/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{jira,
title={Jira - Logiciel de suivi des tickets et des projets},
author={Atlassian},
howpublished="\url{https://www.atlassian.com/fr/software/jira}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{confluence,
title={Confluence - Your remote-friendly team workspace},
author={Atlassian},
howpublished="\url{https://www.atlassian.com/software/confluence}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{vscode,
title={Visual Studio Code - Code editing, redefined},
author={Microsoft},
howpublished="\url{https://code.visualstudio.com/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{slack,
title={Slack is your digital HQ},
author={Slack},
howpublished="\url{https://slack.com/}",
note="[En ligne; accédé le 05 Février 2023]"
}
@misc{nextjs,
title={Next.JS - The React Framework},
author={Vercel},
howpublished="\url{https://nextjs.org/}",
note="[En ligne; accédé le 05 Février 2023]"
}

@ -359,42 +359,74 @@ ainsi que d'être guidé dans l'organisation de la repository.
\subsection{Outils utilisés}
\newcommand{\logowidth}{0.15\textwidth}
\entity{Git} \cite{git} est utilisé pour gérer le versionage du code: cet outil permet de stocker les modifications
apportées au code sous forme de \og commits \fg, et de facilement rassembler et gérer les modifications faites par plusieures personnes.
% wrapfigure does not work with my \entity :(
\begin{wrapfigure}[5]{R}{0.1\textwidth}
\begin{wrapfigure}{r}{\logowidth}
\centering
\includesvg[width=0.1\textwidth]{gitlab_logo.svg}
\includesvg[width=\logowidth]{gitlab_logo.svg}
\caption*{GitLab \cite{gitlabsvgs}}
\end{wrapfigure}
\textbf{GitLab} \cite{gitlab} est utilisé pour stocker les repositories de l'entreprise en ligne,
pour stocker en ligne les packages npm \cite{npm} et pour lancer automatiquement les tâches de \term{Continuous Integration}.
\textbf{VSCode} \cite{vscode} est un éditeur de texte utilisé par presque toute l'équipe pour modifier ou naviger le code.
\textbf{VSCode} \cite{vscode} est un éditeur de texte utilisé par presque toute l'équipe pour modifier ou naviguer le code.
\textbf{Slack} \cite{slack} est une plateforme de messagerie instantanée,
que l'entreprise préfère aux emails pour la communication indirecte.
\textbf{Jira} \cite{jira} est un logiciel de gestion et de suivi de tickets,
que notre équipe utilise pour suivre les tâches à faire durant la semaine,
quelles tâches sont en cours de développement, prêtes à être revues ou finies,
ainsi que pour garder un \term{backlog} des tâches à faible priorité.
\textbf{Confluence} \cite{confluence} est un logiciel qui permet à l'équipe de regrouper des documentations qui n'ont pas de place claire au sein du code.
\textbf{NX} \cite{nx} est un outil simplifiant la gestion de \og monorepositories \fg (des repositories contenant plusieures applications et librairies).
\textbf{NX} est utilisé pour la repository de l'équipe qui contient Mint Service, Mint Admin et Mood TV.
L'objectif au long terme et de migrer l'ensemble des projets de l'équipe sur cette repository,
car elle permet de facilement réutiliser du code entre les projets et de synchroniser des modifications entre projets.
\textbf{Typescript} est une extension au langage \textbf{Javascript}, qui ajoute un système de vérification de types.
\begin{wrapfigure}{r}{\logowidth}
\centering
\includesvg[width=\logowidth]{ts-logo-128.svg}
\caption*{TypeScript \cite{typescriptlogo}}
\end{wrapfigure}
\textbf{Typescript} \cite{typescript} est une extension au langage JavaScript, qui ajoute un système de vérification de types.
Typescript permet d'éviter une classe de bugs causés par des valeurs passées à des fonctions attendant un certain type en entrée.
\\
Typescript existe aujourd'hui en tant que langage qui doit être transpilé en javascript avant de pouvoir être utilisé dans Node.JS ou dans un navigateur,
mais certains interpréteurs (comme \textbf{Bun} \cite{bun}) supportent le typescript,
et il existe une initiative pour standardiser un système permettant d'ajouter des types en javascript sans devoir le traduire.
% Agile, poker planning
% Backlog, recettes, versioning
\textbf{React} \cite{react} est une librairie JavaScript qui permet de facilement construire des interfaces graphiques fortement intéractives.
React permet d'encapsuler l'affichage et la gestion d'évenéments dans des \og composants \fg, qui peuvent être réutilisés de manière modulaire.
React propose aussi une extension de JavaScript, qui permet d'écrire du code HTML directement dans le code JavaScript,
ainsi que d'insérer des composants avec la même syntaxe.
\textbf{Next.JS} \cite{nextjs} est un framework simplifiant l'utilisation de React pour des plus grandes applications:
NextJS permet de séparer l'application en différentes pages,
et de naviguer de manière inintérompue entre ces pages.
NextJS a également pour but d'optimiser la vitesse de chargement de ces pages, en faisant un maximum du rendu de ces pages côté serveur.
\textbf{Nest.JS} \cite{nestjs} est un framework simplifiant la création d'applications back-end.
NestJS utilise l'injection de dépendance pour permettre de plus facilement faire grandir une application back-end,
et propose de nombreux outils pour gérer les requêtes, les bases de données et la documentation.
\subsection{Organisation de l'équipe}
% Agile, poker planning
% Backlog, recettes, versioning
\section{Travail réalisé sur Mint Service}
Mint Service est une application construite avec \entity{NestJS}.
NestJS est un framework permettant de construire des applications côté serveur en Javascript,
NestJS est un framework permettant de construire des applications côté serveur en JavaScript,
et de s'assurer que ces applications soient à la fois sûres, efficaces et flexibles \cite{nestjs}.
\subsection{NestJS et organisation du code}
@ -557,6 +589,42 @@ de convertir les entités de \entity{Mint Service} au format attendu par les ema
\caption{Organisation initiale du système d'envoi de mail dans Mint-Service}
\end{figure}
% mjml
\subsection{Refactor du système de mails}
% - [ ] parler des désavantages de cette méthode
% - [ ] parler de ce qu'on prévoyait de faire
% - [ ] parler de comment on l'a fait (pour showcase l'avantage du monorepo), et des étapes prises
% - [ ] parler des améliorations futures qui pourront être faites
% (ajouter plus de providers, simplifier la logique pour choisir les providers, react.email, svelte, etc.)
\section{Travail sur Mood TV}
\subsection{Introduction?}
% Présentation de la plateforme, des télés (chrome 53 hehe), mentionner procentric
% Parler de l'hydration, du rendu, etc.
\subsection{Analyse des performances}
% Screenshot du panel des performances sur mood tv (avant et après)
% Parler de la loi du milieu, du Z-test, du test de normalité, de comment récupérer ces données
\subsection{Optimisation du temps de chargement}
% - [ ] Optimisation du nombre de requêtes faites (avec un dessin? ~ plus tard)
% - [ ] Optimisation de la taille du bundle
% - [ ] Optimisation du parsing des requêtes
% Avoir de jolis nombres, et un tableau final avec toutes les mesures
\subsection{Refactors}
% - keyboard handler
% - customisations (si ça passe à temps)
% - remise en place de l'ISR, avec un vrai système pour l'activer et le désactiver
\makeutbmbackcover{}
\newpage
\section{Annexes}
@ -567,5 +635,4 @@ de convertir les entités de \entity{Mint Service} au format attendu par les ema
\bibliographystyle{plain}
\bibliography{references}{}
\makeutbmbackcover{}
\end{document}

Loading…
Cancel
Save