doc: clean README
Some checks failed
Build and Publish Docker Images / build-and-push (push) Failing after 1m41s
Some checks failed
Build and Publish Docker Images / build-and-push (push) Failing after 1m41s
This commit is contained in:
44
README.md
44
README.md
@@ -1,10 +1,12 @@
|
||||
# 📚 Notytex - Système de Gestion Scolaire
|
||||
|
||||
**Notytex** est une application web Flask moderne conçue pour la gestion complète des évaluations scolaires. Elle permet aux enseignants de créer, organiser et noter les évaluations de leurs élèves avec une interface intuitive et des fonctionnalités avancées.
|
||||
**Notytex** est une application web Flask conçue pour la gestion complète des évaluations. Elle permet aux enseignants de créer, organiser et noter les évaluations de leurs élèves.
|
||||
|
||||
Cette application a été presque entièrement vibecodé. Il ne faut donc pas s'attendre à des merveilles..! Mais elle est fonctionnelle et je l'utilise pour la gestion de mes notes!
|
||||
|
||||
## 🎯 Objectif Principal
|
||||
|
||||
Simplifier et digitaliser le processus d'évaluation scolaire, de la création des contrôles à la saisie des notes, en offrant une structure hiérarchique flexible et deux modes de notation complémentaires.
|
||||
Simplifier et digitaliser le processus d'évaluation scolaire, de la création des contrôles à la saisie des notes.
|
||||
|
||||
## ⭐ Fonctionnalités Clés
|
||||
|
||||
@@ -45,7 +47,7 @@ Simplifier et digitaliser le processus d'évaluation scolaire, de la création d
|
||||
|
||||
### 🎨 Interface Utilisateur Moderne
|
||||
|
||||
- **Dashboard avec statistiques temps réel** : Cartes interactives avec animations et gradients
|
||||
- **Dashboard avec statistiques** : Cartes interactives
|
||||
- **Navigation intuitive** : Actions principales mises en avant avec design cohérent
|
||||
- **Indicateurs de progression visuels** : Cercles de progression animés avec code couleur
|
||||
- **Design responsive** : Interface adaptée à tous les écrans avec TailwindCSS
|
||||
@@ -85,21 +87,25 @@ uv run flask --app app run --debug
|
||||
**Notytex** propose **3 modes d'initialisation** adaptés aux différents contextes d'usage :
|
||||
|
||||
#### 🌱 **Mode Minimal** (par défaut) - Début d'année scolaire
|
||||
|
||||
```bash
|
||||
uv run flask --app app init-db --mode minimal
|
||||
# ou simplement
|
||||
uv run flask --app app init-db
|
||||
```
|
||||
|
||||
- **Usage** : Début d'année scolaire, base vierge
|
||||
- **Contenu** : Configuration de base uniquement
|
||||
- **Idéal pour** : Démarrer une nouvelle année avec ses vraies classes et élèves
|
||||
|
||||
#### 📚 **Mode Milieu d'Année** - Données réalistes complètes
|
||||
|
||||
```bash
|
||||
uv run flask --app app init-db --mode midyear
|
||||
```
|
||||
|
||||
- **Usage** : Tester l'application avec des données représentatives
|
||||
- **Contenu** :
|
||||
- **Contenu** :
|
||||
- **5 classes** avec 142 élèves au total (25-32 élèves par classe)
|
||||
- **30 évaluations** créées (6 par classe sur 2 trimestres)
|
||||
- **4 évaluations entièrement corrigées** par classe (Trimestre 1)
|
||||
@@ -109,9 +115,11 @@ uv run flask --app app init-db --mode midyear
|
||||
- **Volumétrie** : Correspond aux spécifications du CLAUDE.md (milieu de 2ème trimestre)
|
||||
|
||||
#### 🧪 **Mode Démonstration** - Données minimales
|
||||
|
||||
```bash
|
||||
uv run flask --app app init-db --mode demo
|
||||
```
|
||||
|
||||
- **Usage** : Tests rapides et démonstrations simples
|
||||
- **Contenu** : 2 classes, 5 élèves, 1 évaluation simple
|
||||
- **Idéal pour** : Premiers pas avec l'application
|
||||
@@ -264,7 +272,7 @@ cp .env.example .env
|
||||
|
||||
# 2. Choisir le mode d'initialisation selon le contexte
|
||||
uv run flask --app app init-db --mode minimal # Début d'année
|
||||
uv run flask --app app init-db --mode midyear # Tests avec données complètes
|
||||
uv run flask --app app init-db --mode midyear # Tests avec données complètes
|
||||
uv run flask --app app init-db --mode demo # Démonstration rapide
|
||||
|
||||
# 3. Développement avec rechargement automatique
|
||||
@@ -303,13 +311,6 @@ tail -f logs/notytex.log | jq '.' # Pour formater le JSON
|
||||
- **Contexte automatique** : URL, méthode HTTP, IP, user-agent, timestamp
|
||||
- **Événements métier** : Création/modification/suppression d'évaluations
|
||||
|
||||
### 📈 Métriques Disponibles
|
||||
|
||||
- **Performance** : Temps de réponse des requêtes HTTP
|
||||
- **Métier** : Événements d'évaluation, progression des corrections
|
||||
- **Erreurs** : Exceptions applicatives et techniques
|
||||
- **Utilisation** : Ressources système et base de données
|
||||
|
||||
### 🔍 Exemple de Log Structuré
|
||||
|
||||
```json
|
||||
@@ -336,6 +337,7 @@ uv run flask --app app init-db --mode minimal
|
||||
```
|
||||
|
||||
**Étapes typiques :**
|
||||
|
||||
1. **Configuration initiale** : Année scolaire 2025-2026 automatiquement définie
|
||||
2. **Création des classes** : Ajouter manuellement 6ème A, 5ème B, etc.
|
||||
3. **Import des élèves** : Saisir ou importer les listes d'élèves réelles
|
||||
@@ -349,10 +351,11 @@ uv run flask --app app init-db --mode midyear
|
||||
```
|
||||
|
||||
**Contenu automatiquement généré :**
|
||||
|
||||
- **Classes** : 6ème A (28 élèves), 6ème B (25 élèves), 5ème A (30 élèves), 5ème B (27 élèves), 4ème A (32 élèves)
|
||||
- **Évaluations Trimestre 1** (100% corrigées) :
|
||||
- **Évaluations Trimestre 1** (100% corrigées) :
|
||||
- Contrôle Nombres entiers (coefficient 2.0)
|
||||
- Évaluation Géométrie (coefficient 2.5)
|
||||
- Évaluation Géométrie (coefficient 2.5)
|
||||
- Contrôle Fractions (coefficient 3.0)
|
||||
- Devoir Maison Recherche (coefficient 1.5)
|
||||
- **Évaluations Trimestre 2** (partiellement corrigées) :
|
||||
@@ -360,6 +363,7 @@ uv run flask --app app init-db --mode midyear
|
||||
- Évaluation Statistiques (coefficient 2.0)
|
||||
|
||||
**Utilisation immédiate :**
|
||||
|
||||
1. **Dashboard** : Aperçu des 142 élèves, 30 évaluations, 5 classes
|
||||
2. **Indicateurs de progression** : Visualisation des corrections en cours
|
||||
3. **Analyse des résultats** : Statistiques et graphiques sur les évaluations terminées
|
||||
@@ -368,12 +372,10 @@ uv run flask --app app init-db --mode midyear
|
||||
### 📝 **Scénario Création d'Évaluation** - Workflow Standard
|
||||
|
||||
1. **🏗️ Création de l'évaluation**
|
||||
|
||||
- Titre : "Contrôle Chapitre 3 - Fonctions"
|
||||
- Paramètres : Date, **trimestre obligatoire** (ex: 2), classe, coefficient
|
||||
|
||||
2. **⚙️ Structure de l'évaluation**
|
||||
|
||||
- **Exercice 1** : "Calculs de base" (notes en points)
|
||||
- Question 1a : 2 points
|
||||
- Question 1b : 3 points
|
||||
@@ -381,7 +383,6 @@ uv run flask --app app init-db --mode midyear
|
||||
- Compétence "Lire un graphique" : échelle 0-3
|
||||
|
||||
3. **📊 Suivi de la progression**
|
||||
|
||||
- **Indicateur initial** : "Correction 0%" (rouge) visible sur toutes les pages
|
||||
- **Saisie des notes** : Clic sur l'indicateur → accès direct à la page de notation
|
||||
- **Progression temps réel** : "Correction 45%" (orange) → "Correction 100%" (vert)
|
||||
@@ -413,18 +414,9 @@ uv run flask --app app init-db --mode midyear
|
||||
### 🎓 Utilisateurs Principaux
|
||||
|
||||
- **Enseignants** du secondaire (collège, lycée)
|
||||
- **Équipes pédagogiques** souhaitant harmoniser leurs pratiques d'évaluation
|
||||
- **Établissements scolaires** en transition vers le numérique
|
||||
|
||||
### 📚 Contextes Pédagogiques
|
||||
|
||||
- **Coexistence des pratiques** : Notation classique ET évaluation par compétences
|
||||
- **Gestion par trimestre** : Organisation structurée des évaluations scolaires
|
||||
- **Diversité des exercices** : Support des différents formats de contrôles
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Conclusion
|
||||
|
||||
**Notytex** combine une **architecture technique moderne et robuste** avec une **interface utilisateur intuitive** centrée sur l'expérience enseignant. Grâce à ses indicateurs de progression intégrés, son système de notation dual et ses analyses statistiques avancées, il répond concrètement aux besoins du monde éducatif tout en respectant les meilleures pratiques du développement logiciel.
|
||||
|
||||
|
Reference in New Issue
Block a user