EduMatrix Virtual Classroom

FullStack -Projekt

Dieses Projekt ist eine FullStack -Webanwendung, die mit React (Frontend) und Node.js (Backend) erstellt wurde. Der Frontend ist mit vite konfiguriert und befindet sich im client -Ordner, während der Backend -Server mit node.js ausgeführt wird und mit npm run dev gestartet werden kann.

Über das Projekt

Edumatrix ist eine virtuelle Klassenzimmerplattform, die eine nahtlose und interaktive Lernerfahrung bietet. Es wurde mit dem Mern-Stack erstellt und integriert Echtzeit-Kommunikationsfunktionen mit Socket.io und WEBRTC, um Live-Klassen, Videokonferenzen und kollaborative Tools wie ein gemeinsames Whiteboard und Chat zu ermöglichen.

Ziele

1. Verbesserung der Online -Ausbildung : Stellen Sie eine Plattform zur Verfügung, die die Lücke zwischen traditionellen Klassenzimmern und virtuellem Lernen überbrückt und eine reiche und interaktive Erfahrung für Schüler und Pädagogen gleichermaßen gewährleistet.
2. Barrierefreiheit : Machen Sie Ausbildung für Benutzer auf der ganzen Welt zugänglich, indem Sie eine zuverlässige und benutzerfreundliche Plattform anbieten.
3. Echtzeit-Interaktion : Erleichterung effektiver Kommunikation und Zusammenarbeit zwischen Lehrern und Schülern durch Videokonferenzen, Chat und interaktive Tools.
4. Skalierbarkeit : Erstellen Sie ein System, das skalieren kann, um eine große Anzahl von gleichzeitigen Benutzern zu unterstützen, ohne die Leistung zu beeinträchtigen.
5. Anpassung : Ermöglichen Sie den Institutionen und Pädagogen, die Plattform auf ihre spezifischen Bedürfnisse anzupassen.

Inhaltsverzeichnis

• Merkmale
• Projektstruktur
• Setup -Anweisungen
• Beitragen

Merkmale

• Frontend : Mit React gebaut, mit VITE für schnellere Build und optimierte Entwicklungserfahrung konfiguriert.
• Backend : Powered von node.js mit einem API -Server.
• Echtzeitkommunikation : Unterstützt Live-Videokonferenzen und Chat mit WEBRTC und Socket.io.
• Interaktive Tools : Enthält ein gemeinsames Whiteboard für die Zusammenarbeit während des Unterrichts.
• Sichere Authentifizierung : Implementiert sichere Login und Benutzerverwaltung.
• Responsive Design : Gewährleistet die Verwendbarkeit über Geräte hinweg, einschließlich Desktops, Tablets und Smartphones.
• FullStack -Integration : Frontend und Backend sind nahtlos für eine effiziente Datenbearbeitung verbunden.

Projektstruktur

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

Setup -Anweisungen

Voraussetzungen

• Node.js und NPM auf Ihrem Computer installiert.

1. Klonen Sie das Repository klonen

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

2. Installieren Sie Abhängigkeiten

Navigieren Sie sowohl zu den Client- als auch zum Server -Ordner, um die erforderlichen Abhängigkeiten zu installieren.

Frontend

 cd client
npm install

Backend

 cd ../server
npm install

3. Konfigurieren Sie Umgebungsvariablen

Erstellen Sie eine .env -Datei im server und fügen Sie alle erforderlichen Umgebungsvariablen hinzu, z. B. Datenbankverbindungszeichenfolgen, API -Schlüssel und andere Konfigurationen.

4. Starten Sie die Anwendung

Backend Server

Führen Sie den folgenden Befehl aus dem server aus, um den Backend -Server zu starten:

npm run dev

Dadurch wird der Backend -Server im Entwicklungsmodus gestartet.

Frontend Server

Führen Sie den folgenden Befehl aus dem client -Ordner aus, um den Frontend -Server zu starten:

npm run dev

5. Zugriff auf die Anwendung

Sobald sowohl die Frontend- als auch die Backend -Server ausgeführt werden, können Sie standardmäßig auf die Anwendung unter http://localhost:5173 zugreifen.

Beitragen

Wir begrüßen Beiträge! Um einen Beitrag zu leisten, befolgen Sie bitte die folgenden Schritte:

1. Geben Sie das Repository aus und erstellen Sie Ihren Zweig:

   git checkout -b feature/YourFeature

2. Nehmen Sie Ihre Änderungen vor und verpflichten Sie sie mit einer sinnvollen Botschaft:

   git commit -m " Add YourFeature "

3. Drücken Sie auf Ihre Gabel und senden Sie eine Pull -Anfrage:

   git push origin feature/YourFeature

4. Senden Sie eine Pull -Anfrage von Ihrem Gabel -Repository an die main des Hauptrepositorys. Unser Team wird Ihre Pull -Anfrage überprüfen und alle erforderlichen Änderungen vorschlagen.

Entwicklungsrichtlinien

• Gewährleistung der Codekonsistenz und Lesbarkeit.
• Schreiben Sie aussagekräftige Commit -Nachrichten.
• Testen Sie Ihre Änderungen, bevor Sie eine Pull -Anfrage einreichen.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.

---