Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dan149/la-croix-quiz-logiciel-prof

Logiciel de création de quiz pour enseignants. Fabriqué avec ❤️ par l'initiative du Lycée Saint Jean & La Croix à Saint Quentin.
https://github.com/dan149/la-croix-quiz-logiciel-prof

education educational electron for-teacher francais france french french-language js quiz react school school-project software student-project teacher teachers teaching teaching-materials

Last synced: about 2 months ago
JSON representation

Logiciel de création de quiz pour enseignants. Fabriqué avec ❤️ par l'initiative du Lycée Saint Jean & La Croix à Saint Quentin.

Awesome Lists containing this project

README

        

# La Croix Quiz

## Logiciel de création de quiz scolaire

> Créé par Daniel Falkov dans le cadre d'un projet scolaire au lycée Saint Jean & La Croix à Saint Quentin, Aisne.

---

### Connexion

Le professeur lance le logiciel à partir de son ordinateur, les élèves peuvent dès le lancement du serveur par le biais du logiciel rejoindre la session de quiz en cours à partir d'un navigateur web sur l'addresse ip du professeur au port 3333:

`http://:3333`

*Attention: la machine du professeur doit être connectée au même réseau que celles des élèves.*

---

### Compilation

Voici les étapes à suivre pour compiler soi-même le logiciel:

1- Assurez-vous d'avoir installé npm.

2- Clonez le projet sur votre machine:

- Par le terminal/cmd (git doit être installé):

`git clone https://github.com/Dan149/la-croix-quiz-logiciel-prof`

- ou téléchargez le zip sur la page d'accueil du projet.

3- Depuis le terminal, dans le dossier du projet, installez les dépendences: `npm install`

4- Pour finir, compilez: `npm run build`

L'exécutable se trouvera dans le dossier _release_, dans le sous-dossier portant le nom de la version.

---

### Captures d'écran

Afficher les images

![Copie d'écran_20240331_205917](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/09df4d21-0000-43ee-a0fd-d5fc0aa5830c)
![Copie d'écran_20240331_210021](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/69999c4a-740e-48ee-a4b6-4b4fca320f7d)
![Copie d'écran_20240331_210043](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/af6d68fd-85d9-4d97-aca3-ea48e9a0dc85)
![Copie d'écran_20240331_210108](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/b34cd5ab-de84-4e89-a06e-f0bcae509c65)
![Copie d'écran_20240331_210206](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/b4a8acc7-2a15-45c6-b50d-be9644387f9a)
![Copie d'écran_20240331_210255](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/cc8a8f59-fd8f-4cef-ac70-02a34df42a19)
![Copie d'écran_20240331_210328](https://github.com/Dan149/la-croix-quiz-logiciel-prof/assets/48863749/bf663706-a9b2-44e3-8893-8318a86dcbbd)

---

## Documentation interne (pour développeurs):

### Index:
- Structure du logiciel
- Technologies employées

Structure du logiciel


Le logiciel se décompose en 3 parties principales ayant chacun une fonction et des principes de fonctionnement propres:

- __Le processus principal__: partie du logiciel du professeur qui effectue des opérations sur l'ordinateur (démarrer le serveur, intéragir avec le système de fichiers, ouvrir la fenêtre etc..."), ce processus se trouve dans `electron/main.ts`.

- __L'interface utilisateur__: Interface affichée au professeur, démarée dans une fenêtre par le processus principal, intéragissant avec celui-ci à l'aide d'un tunnel semblable à une API qui se trouve dans le fichier `electron/preload.ts`. L'interface est codée comme un site web, plus d'informations dans la partie technologies employées, elle se situe dans le dossier `src/`.

- __L'application web__: Site web se trouvant sous forme "compilée" dans le dossier `public/client`, il est envoyé à chaque utilisateur (élève) se connectant au serveur. Le site web est codé séparément par moi-même, dans un répértoire Github privé différent, il possède donc un nom de version lui étant propre.

Technologies employées


Le site web et l'interface du logiciel sont tous deux codés avec la même librairie JavaScript: React, qui permet de générer un fichier html unique, affiché par l'utilisateur.

Le processus principal lui aussi est codé en JavaScript, grâce à un environnement d'exécution nommé Node.js, qui permet l'éxecution de JS hors navigateur classique. Les feuilles de styles en cascade pour les interfaces sont codées au format Sass (dérivée .scss), qui est ensuite "compilé" vers du CSS standard.