Examen

Site Web + API

Documentation du Portail Professeurs

Table des matières

  1. Introduction
  2. Architecture technique
  3. Structure du projet
  4. Fonctionnalités principales
  5. Guide d'utilisation
  6. API et endpoints
  7. Base de données
  8. Sécurité
  9. Déploiement
  10. Dépannage

1. Introduction

Le Portail Professeurs est une application web conçue pour aider les enseignants à gérer efficacement leurs classes, les absences des élèves, les réservations de salles, et à communiquer avec les autres membres de l'établissement. Cette plateforme centralisée offre une interface intuitive et responsive qui s'adapte à tous les appareils.

Objectifs du projet

2. Architecture technique

Frontend

Backend

Base de données

3. Structure du projet

Frontend (Next.js)

/app                     # Dossier principal des routes (App Router)
  /absences              # Gestion des absences
  /classes               # Gestion des classes
  /login                 # Page de connexion
  /messages              # Système de messagerie
  /notifications         # Centre de notifications
  /parametres            # Paramètres utilisateur
  /points                # Système de points
  /rapports              # Génération de rapports
  /reservations          # Réservation de salles
  /salles                # Gestion des salles
  /statistiques          # Tableaux de bord et statistiques
  /layout.tsx            # Layout principal
  /globals.css           # Styles globaux
  /page.tsx              # Page d'accueil

/components              # Composants réutilisables
  /ui                    # Composants UI (shadcn)
  /header.tsx            # En-tête de l'application
  /sidebar.tsx           # Barre latérale de navigation
  /auth-guard.tsx        # Protection des routes authentifiées

/lib                     # Services et utilitaires
  /api-client.ts         # Client API centralisé
  /auth-service.ts       # Service d'authentification
  /absence-service.ts    # Service de gestion des absences
  /class-service.ts      # Service de gestion des classes
  /message-service.ts    # Service de messagerie
  /points-service.ts     # Service de gestion des points
  /room-service.ts       # Service de gestion des salles
  /settings-service.ts   # Service de gestion des paramètres

/public                  # Fichiers statiques

Backend (ASP.NET Core)

/Controllers             # Contrôleurs API
  /AuthController.cs     # Authentification
  /Teacher               # Contrôleurs spécifiques aux enseignants
    /TeacherAbsenceController.cs
    /TeacherClassController.cs
    /TeacherProfileController.cs
    /TeacherRoomController.cs
    /TeacherSettingsController.cs
    /TeacherStatController.cs
  /Message               # Contrôleurs de messagerie
    /MessageController.cs
  /Points                # Contrôleurs de gestion des points
    /PointsController.cs

/Models                  # Modèles de données
  /Absence.cs
  /Class.cs
  /Message.cs
  /Notification.cs
  /PointsConfig.cs
  /PointsHistory.cs
  /Reservation.cs
  /Room.cs
  /Schedule.cs
  /Settings.cs
  /Student.cs
  /StudentPoints.cs
  /Teacher.cs
  /User.cs
  /GestionAbsencesContext.cs  # Contexte EF Core

/DTO                     # Objets de transfert de données
  /AbsenceDTO.cs
  /AuthDTO.cs
  /ClassDTO.cs
  /Message
    /MessageDTO.cs
    /ConversationDTO.cs
  /Points
    /StudentPointsDTO.cs
    /PointsHistoryDTO.cs
  /Teacher
    /TeacherProfileDTO.cs

/Services                # Services métier
  /Teacher
    /TeacherAbsenceService.cs
    /TeacherClassService.cs
    /TeacherProfileService.cs
    /TeacherRoomService.cs
    /TeacherSettingsService.cs
    /TeacherStatService.cs
  /Message
    /MessageService.cs
  /Points
    /PointsService.cs

/WebSocket               # Gestion des WebSockets
  /WebSocketHandler.cs
  /WebSocketMiddleware.cs
  /WebSocketExtensions.cs

/Utils                   # Utilitaires
  /DateOnlyJsonConverter.cs
  /DateUtils.cs

/Middleware              # Middlewares personnalisés
  /BearerPrefixMiddleware.cs
  /RequestResponseLoggingMiddleware.cs

/Scripts                 # Scripts SQL

4. Fonctionnalités principales

Authentification et sécurité

Gestion des classes

Gestion des absences

Système de points

Réservation de salles

Messagerie

Rapports et statistiques

Paramètres utilisateur

5. Guide d'utilisation

Connexion au portail

  1. Accédez à la page de connexion
  2. Entrez les identifiants suivants :
    • Email : teacher@teacher.fr
    • Mot de passe : admin123
  3. Cliquez sur "Se connecter"

Navigation dans l'application

Gestion des classes

  1. Accédez à la section "Classes" depuis la barre latérale
  2. Consultez la liste de vos classes
  3. Cliquez sur une classe pour voir les détails et la liste des élèves
  4. Utilisez la barre de recherche pour filtrer les classes

Saisie des absences

  1. Accédez à la section "Absences" depuis la barre latérale
  2. Cliquez sur "Saisir des absences"
  3. Sélectionnez la classe concernée
  4. Cochez les élèves absents
  5. Renseignez la date et le motif si connu
  6. Validez la saisie

Réservation d'une salle

  1. Accédez à la section "Salles" depuis la barre latérale
  2. Consultez les salles disponibles
  3. Cliquez sur "Nouvelle réservation"
  4. Sélectionnez la salle, la date et l'horaire
  5. Indiquez le motif de la réservation
  6. Validez la réservation

Utilisation du système de points

  1. Accédez à la section "Points" depuis la barre latérale
  2. Consultez le classement des élèves
  3. Pour attribuer des points :
    • Accédez à la fiche d'un élève
    • Cliquez sur "Ajouter des points"
    • Saisissez le nombre de points et le motif
    • Validez l'attribution

Envoi d'un message

  1. Accédez à la section "Messages" depuis la barre latérale
  2. Cliquez sur "Nouveau message"
  3. Sélectionnez le destinataire
  4. Rédigez votre message
  5. Envoyez le message

Génération d'un rapport

  1. Accédez à la section "Rapports" depuis la barre latérale
  2. Sélectionnez le type de rapport
  3. Définissez les paramètres (période, classe, etc.)
  4. Générez le rapport
  5. Consultez-le en ligne ou exportez-le

Modification des paramètres

  1. Accédez à la section "Paramètres" depuis la barre latérale
  2. Modifiez votre profil, thème ou préférences
  3. Enregistrez les modifications

6. API et endpoints

Authentification

Gestion des classes

Gestion des absences

Gestion des salles

Réservations

Messagerie

Système de points

Profil et paramètres

7. Base de données

Schéma de la base de données

La base de données est organisée autour des entités principales suivantes :

Relations principales

8. Sécurité

Authentification

Protection des données

Autorisations

9. Déploiement

Prérequis

Étapes de déploiement

  1. Base de données

    • Créer une base de données MySQL
    • Exécuter les scripts de migration
  2. Backend

    • Compiler l'application ASP.NET Core
    • Configurer les variables d'environnement
    • Déployer sur un serveur compatible .NET
  3. Frontend

    • Construire l'application Next.js (next build)
    • Déployer les fichiers statiques
    • Configurer le serveur web pour servir l'application

Configuration

10. Dépannage

Problèmes courants

Erreur de connexion

Données non affichées

Erreurs WebSocket

Problèmes de performance

Logs et monitoring

Application Mobile

Application Mobile de Gestion des Absences

Présentation

Cette application mobile Android permet aux enseignants de gérer les absences des élèves, consulter leurs classes, et accéder à diverses statistiques. Elle est conçue pour fonctionner en complément d'une API REST qui gère les données côté serveur.

Informations de connexion

Pour tester l'application, utilisez les identifiants suivants :

Architecture de l'application

L'application est développée selon le pattern MVVM (Model-View-ViewModel) et utilise les composants d'architecture Android :

  • Model : Représente les données et la logique métier
  • View : Activités et fragments qui affichent l'interface utilisateur
  • ViewModel : Gère les données liées à l'UI et les interactions avec le modèle
  • Repository : Couche intermédiaire qui gère les sources de données (API, base de données locale)

Structure des packages

com.example.exam/
├── adapters/           # Adaptateurs pour les RecyclerViews
├── api/                # Services API et configuration Retrofit
├── models/             # Classes de modèles de données
├── repository/         # Repositories pour accéder aux données
├── ui/                 # Activités et fragments organisés par fonctionnalité
│   ├── absences/       # Gestion des absences
│   ├── classes/        # Gestion des classes
│   ├── home/           # Écran d'accueil et tableau de bord
│   └── ...
└── utils/              # Classes utilitaires

Fonctionnalités principales

1. Authentification

  • Connexion avec email/mot de passe
  • Stockage sécurisé du token d'authentification
  • Déconnexion

2. Tableau de bord (Dashboard)

  • Vue d'ensemble des statistiques (nombre d'élèves, classes, absences)
  • Graphique des absences par mois
  • Liste des absences récentes
  • Fonctionnalité de rafraîchissement (swipe-to-refresh)

3. Gestion des classes

  • Liste des classes de l'enseignant
  • Détails d'une classe avec liste des élèves
  • Statistiques par classe (taux d'absence, nombre d'élèves)

4. Gestion des absences

  • Consultation des absences
  • Saisie d'une nouvelle absence
  • Possibilité de joindre un justificatif (document)
  • Filtrage des absences

Flux d'utilisation

Connexion et navigation

  1. L'utilisateur lance l'application et arrive sur l'écran de connexion
  2. Après authentification réussie, l'utilisateur est redirigé vers le tableau de bord
  3. La navigation entre les différentes sections se fait via le menu latéral (Navigation Drawer)

Consultation des classes

  1. L'utilisateur accède à la section "Classes" depuis le menu
  2. La liste des classes s'affiche avec des informations de base
  3. En cliquant sur une classe, l'utilisateur accède aux détails et à la liste des élèves
  4. Depuis cette vue, l'utilisateur peut saisir une absence ou générer un rapport

Saisie d'une absence

  1. Depuis la liste des classes ou les détails d'une classe, l'utilisateur peut cliquer sur "Saisir une absence"
  2. Un formulaire s'affiche permettant de sélectionner l'élève, la date, le statut et la raison
  3. L'utilisateur peut optionnellement joindre un document justificatif
  4. Après validation, l'absence est enregistrée et l'utilisateur est redirigé vers l'écran précédent

Technologies utilisées

Bibliothèques principales

  • AndroidX : Composants d'architecture Android (ViewModel, LiveData)
  • Material Design : Composants UI modernes et cohérents
  • Retrofit : Client HTTP pour les appels API
  • OkHttp : Client HTTP sous-jacent avec intercepteurs pour logging
  • Gson : Sérialisation/désérialisation JSON
  • MPAndroidChart : Visualisation de données sous forme de graphiques
  • Lottie : Animations vectorielles
  • Shimmer : Effets de chargement
  • SwipeRefreshLayout : Fonctionnalité de rafraîchissement par glissement

Gestion des données

  • SharedPreferences : Stockage des informations de session (token, identifiants)
  • LiveData : Notification des changements de données aux composants UI
  • ViewModel : Persistance des données lors des changements de configuration

Détails techniques

Authentification et sécurité

L'application utilise un système d'authentification par token JWT :

  1. L'utilisateur s'authentifie avec ses identifiants
  2. Le serveur renvoie un token JWT
  3. Ce token est stocké dans les SharedPreferences
  4. Un intercepteur OkHttp ajoute automatiquement le token à chaque requête API

Gestion des erreurs

L'application gère différents types d'erreurs :

  • Erreurs réseau (pas de connexion)
  • Erreurs d'authentification (token expiré, identifiants incorrects)
  • Erreurs serveur (500, 404, etc.)

Des écrans d'erreur spécifiques sont affichés avec possibilité de réessayer.

Optimisations UI/UX

  • Shimmer Effect : Affichage d'un effet de chargement pendant les requêtes API
  • Animations : Transitions fluides entre les écrans
  • Swipe-to-refresh : Actualisation des données par glissement vers le bas
  • Mise en cache : Certaines données sont mises en cache pour améliorer les performances

API et endpoints

L'application communique avec une API REST hébergée à l'adresse https://api.slam.qoyri.fr/api/.

Principaux endpoints utilisés

  • Authentification : /auth/login
  • Dashboard : /teacher/dashboard
  • Classes : /teacher/classes
  • Détails d'une classe : /teacher/classes/{id}
  • Absences : /teacher/absences
  • Création d'absence : /teacher/absences/create

Installation et déploiement

Prérequis

  • Android Studio 4.0+
  • JDK 11+
  • SDK Android 33+ (Android 13)

Compilation et installation

  1. Cloner le dépôt
  2. Ouvrir le projet dans Android Studio
  3. Synchroniser avec Gradle
  4. Compiler et installer sur un appareil ou émulateur

Configuration

L'URL de l'API est configurée dans la classe ApiClient.java. Pour changer l'environnement (développement, production), modifiez la constante BASE_URL.

Dépannage

Problèmes courants

  1. Erreur de connexion : Vérifiez votre connexion internet et que l'API est accessible
  2. Erreur d'authentification : Vérifiez vos identifiants ou réessayez de vous connecter
  3. Données non affichées : Utilisez la fonction de rafraîchissement (swipe-to-refresh)

Évolutions futures

  • Implémentation du mode hors ligne avec synchronisation
  • Ajout de notifications push pour les nouvelles absences
  • Intégration de la biométrie pour l'authentification
  • Support du mode sombre