EduMatrix Virtual Classroom

Projet de Fullstack

Ce projet est une application Web Fullstack construite avec React (Frontend) et Node.js (backend). Le frontend est configuré avec VITE et est situé dans le dossier client , tandis que le serveur backend s'exécute avec Node.js et peut être démarré avec npm run dev .

À propos du projet

Edumatrix est une plate-forme de classe virtuelle conçue pour offrir une expérience d'apprentissage transparente et interactive. Construit avec la pile Mern, il intègre des fonctionnalités de communication en temps réel à l'aide de socket.io et webrtc pour permettre des cours en direct, une vidéoconférence et des outils de collaboration tels qu'un tableau blanc et un chat partagés.

Objectifs

1. Améliorer l'éducation en ligne : fournir une plate-forme qui comble le fossé entre les salles de classe traditionnelles et l'apprentissage virtuel, assurant une expérience riche et interactive pour les étudiants et les éducateurs.
2. Accessibilité : rendre l'éducation accessible aux utilisateurs du monde entier en offrant une plate-forme fiable et conviviale.
3. Interaction en temps réel : faciliter une communication et une collaboration efficaces entre les enseignants et les élèves par le biais de vidéos, des outils de chat et interactifs.
4. Évolutivité : construire un système qui peut évoluer pour prendre en charge un grand nombre d'utilisateurs simultanés sans compromettre les performances.
5. Personnalisation : permettre aux institutions et aux éducateurs d'adapter la plate-forme à leurs besoins spécifiques.

Table des matières

• Caractéristiques
• Structure du projet
• Instructions de configuration
• Contributif

Caractéristiques

• Frontend : Construit avec React, configuré avec Vite pour une construction plus rapide et une expérience de développement optimisée.
• Backend : alimenté par node.js avec un serveur API.
• Communication en temps réel : prend en charge la vidéoconférence en direct et le chat à l'aide de webrtc et socket.io.
• Outils interactifs : comprend un tableau blanc partagé pour la collaboration pendant les cours.
• Authentification sécurisée : implémente la connexion sécurisée et la gestion des utilisateurs.
• Conception réactive : assure la convivialité entre les appareils, y compris les ordinateurs de bureau, les tablettes et les smartphones.
• Intégration de Fullstack : Frontend et backend connecté de manière transparente pour une gestion efficace des données.

Structure du projet

 root
├── client         # Frontend (React with Vite)
└── server         # Backend (Node.js with Express)

Instructions de configuration

Condition préalable

• Node.js et NPM sont installés sur votre machine.

1. Clone le référentiel

git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name

2. Installez les dépendances

Accédez aux dossiers du client et du serveur pour installer les dépendances nécessaires.

L'extrémité avant

 cd client
npm install

Backend

 cd ../server
npm install

3. Configurer les variables d'environnement

Créez un fichier .env dans le répertoire server et ajoutez toutes les variables d'environnement requises, telles que les chaînes de connexion de base de données, les clés d'API et d'autres configurations.

4. Démarrez l'application

Serveur backend

Pour démarrer le serveur backend, exécutez la commande suivante dans le dossier server :

npm run dev

Cela démarrera le serveur backend en mode développement.

Serveur de frontend

Pour démarrer le serveur Frontend, exécutez la commande suivante à partir du dossier client :

npm run dev

5. Accéder à l'application

Une fois que les serveurs frontend et backend fonctionnent, vous pouvez accéder à l'application sur http://localhost:5173 par défaut.

Contributif

Nous accueillons les contributions! Pour contribuer, veuillez suivre ces étapes:

1. Fourchez le référentiel et créez votre branche:

   git checkout -b feature/YourFeature

2. Faites vos modifications et engagez-les avec un message significatif:

   git commit -m " Add YourFeature "

3. Poussez à votre fourche et soumettez une demande de traction:

   git push origin feature/YourFeature

4. Soumettez une demande de traction de votre référentiel fourchu à la branche main du référentiel principal. Notre équipe examinera votre demande de traction et suggérera les modifications nécessaires.

Lignes directrices de développement

• Assurer la cohérence et la lisibilité du code.
• Écrivez des messages de validation significatifs.
• Testez vos modifications avant de soumettre une demande de traction.

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.

---