From 2000a47f173bbf7b48f7f4c709ea07454f8a677a Mon Sep 17 00:00:00 2001 From: Gabriel Matte Date: Mon, 25 Nov 2024 22:35:36 -0500 Subject: [PATCH] Adds basic docs --- .gitignore | 2 + documentation/dev.py | 2 - .../developpeur/documentation/a-propos.md | 6 +- documentation/docs/developpeur/index.md | 78 +++++++++++++++++++ documentation/python-version | 1 + documentation/requirements.txt | 3 +- 6 files changed, 87 insertions(+), 5 deletions(-) delete mode 100644 documentation/dev.py create mode 100644 documentation/docs/developpeur/index.md create mode 100644 documentation/python-version diff --git a/.gitignore b/.gitignore index 6e8de7b..551aa14 100644 --- a/.gitignore +++ b/.gitignore @@ -129,3 +129,5 @@ dist .yarn/install-state.gz .pnp.* db-backup/ + +.venv \ No newline at end of file diff --git a/documentation/dev.py b/documentation/dev.py deleted file mode 100644 index 12e9687..0000000 --- a/documentation/dev.py +++ /dev/null @@ -1,2 +0,0 @@ -from plantuml import PlantUML -server = PlantUML(url='http://localhost:8080/plantuml') diff --git a/documentation/docs/developpeur/documentation/a-propos.md b/documentation/docs/developpeur/documentation/a-propos.md index 2af1023..407e09a 100644 --- a/documentation/docs/developpeur/documentation/a-propos.md +++ b/documentation/docs/developpeur/documentation/a-propos.md @@ -16,4 +16,8 @@ La page est poussée sur la branche [`gh-pages`](https://github.com/ets-cfuhrman Si vous ajoutez des plugins, veuillez mettre a jour le fichier `requirements.txt`. La documentation utilise [MkDocs](https://www.mkdocs.org/) avec [le theme matérial]((https://squidfunk.github.io/mkdocs-material/)). Il y a bien des fonctionalitées tel que les code-blocks qui peuvent être activés. -Vous pouvez avoir accès a la documentation ici : [https://squidfunk.github.io/mkdocs-material/reference/code-blocks/](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) \ No newline at end of file +Vous pouvez avoir accès a la documentation ici : [https://squidfunk.github.io/mkdocs-material/reference/code-blocks/](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) + +## Autre méthode de lancement (virtuel) +Si vous avez un probleme avec votre environement et vous avez besoin d'un environement virtuel, il s'agit de faire `python -m venv .venv` dans le dossier document et d'activer cet environemment avec le fichier activate (changeant depedant de votre invite de commande) : `.venv\script\activate` +vous pouvez ensuite continuer les autres étapes. \ No newline at end of file diff --git a/documentation/docs/developpeur/index.md b/documentation/docs/developpeur/index.md new file mode 100644 index 0000000..14e4554 --- /dev/null +++ b/documentation/docs/developpeur/index.md @@ -0,0 +1,78 @@ +# Structure haut niveau + +## But du projet +ÉvalueTonSavoir a été créer dû aux gros coûts des versions entreprises des logiciels similaires tels que Socrative et Kahoot. Le bût principal est d’être capable d’avoir une plateforme auto-hébergée et bien intégrée dans les systèmes déjà présents des établissements scolaire. + +## Requis + +Le but du projet étant un outils gratuis/libre afin d'améliorer l'apprentissage, celui-ci a les bûts suivants : + +- Permettre aux personnels enseignant de créer des tests +- Permettre aux enseignant de collecter les résultats des tests +- Permettre aux étudiants de prendre ces tests +- Permettre aux étudiants d'avoir une rétroaction + +Afin de limiter le niveau de difficulté d'intégration du personnel enseignant: + +- L'utilisation du format [`GIFT`](https://docs.moodle.org/405/en/GIFT_format) déja présent dans moodle doit être utilisé +- Le personnel et les étudiants doivent être capable de s'authentifier avec le portail de l'école +- Le démarage du quiz doit se faire de facon rapide et éfficace. + +Afin de faciliter le déploiement de masse : + +- Le logiciel doit être facile a déployer sur des machines locales +- Le logiciel doit être facile a déployer sur le cloud +- Le logiciel doit s'interconnecter à l'infrastructure présente +- Le logiciel doit être performant et fiable + +## Architecture actuelle + +```plantuml +@startuml + + +package Proxy{ + component Nginx +} + +package App{ + component Frontend + component Backend + database MongoDb +} + +cloud Provider{ + component QuizRoom +} + + +Nginx --down-> Backend +Nginx --down-> Frontend +Nginx --down-> Provider + +Backend --right-> MongoDb +Backend --up-> Nginx + +Frontend --up-> Nginx +@enduml +``` + +### Details techniques + +Le tableau ci-dessus est simplifié grandement car toutes les composantes sont individuelles. Ce qui veux dire qu'une toutes les parties pouraient être déployé sur un serveur différent et tout de même fonctionner, permettant de distribuer la charge de travail facilement. + +Le proxy Nginx permet de camoufler la séparation du backend et frontend en réunissant les deux parties sous la même url. Il a aussi la tache de diriger les appels de sockets vers leurs machine interne dans le provider. + +Le frontend déssert la partie visuel de l'application. + +Le backend s'occupe de tous les services tel quel : + +- La gestion des utilisateurs +- La gestion des quizs +- La gestion des médias +- La gestion des salles + + +### Liens vers détails supplémentaires +- [Gestion de l'authentification](./backend/auth.md) +- [Gestion de la salle de Quiz](./backend/salle-de-quiz.md) \ No newline at end of file diff --git a/documentation/python-version b/documentation/python-version new file mode 100644 index 0000000..fdcfcfd --- /dev/null +++ b/documentation/python-version @@ -0,0 +1 @@ +3.12 \ No newline at end of file diff --git a/documentation/requirements.txt b/documentation/requirements.txt index 4dab312..1feb057 100644 --- a/documentation/requirements.txt +++ b/documentation/requirements.txt @@ -3,5 +3,4 @@ mkdocs[i18n] mkdocs_puml mkdocs-material Pygments -ghp-import -plantuml \ No newline at end of file +ghp-import \ No newline at end of file