Adds basic docs

This commit is contained in:
Gabriel Matte 2024-11-25 22:35:36 -05:00
parent 115d3785ca
commit 2000a47f17
6 changed files with 87 additions and 5 deletions

2
.gitignore vendored
View file

@ -129,3 +129,5 @@ dist
.yarn/install-state.gz .yarn/install-state.gz
.pnp.* .pnp.*
db-backup/ db-backup/
.venv

View file

@ -1,2 +0,0 @@
from plantuml import PlantUML
server = PlantUML(url='http://localhost:8080/plantuml')

View file

@ -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`. 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. 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/) 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.

View file

@ -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 davoir 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)

View file

@ -0,0 +1 @@
3.12

View file

@ -3,5 +3,4 @@ mkdocs[i18n]
mkdocs_puml mkdocs_puml
mkdocs-material mkdocs-material
Pygments Pygments
ghp-import ghp-import
plantuml