EduMatrix Virtual Classroom

Proyecto FullStack

Este proyecto es una aplicación web FullStack construida con React (Frontend) y Node.js (Backend). El frontend está configurado con VITE y se encuentra en la carpeta client , mientras que el servidor de backend se ejecuta con Node.js y se puede iniciar con npm run dev .

Sobre el proyecto

Edumatrix es una plataforma virtual en el aula diseñada para proporcionar una experiencia de aprendizaje perfecta e interactiva. Construido con la pila Mern, integra características de comunicación en tiempo real utilizando Socket.io y WebRTC para habilitar clases en vivo, videoconferencias y herramientas de colaboración, como una pizarra y un chat compartido.

Objetivos

1. Mejore la educación en línea : proporcione una plataforma que cida la brecha entre las aulas tradicionales y el aprendizaje virtual, asegurando una experiencia rica e interactiva tanto para estudiantes como para los educadores.
2. Accesibilidad : haga que la educación sea accesible para los usuarios de todo el mundo ofreciendo una plataforma confiable y fácil de usar.
3. Interacción en tiempo real : facilitar la comunicación y la colaboración efectivas entre maestros y estudiantes a través de videoconferencias, chat y herramientas interactivas.
4. Escalabilidad : Cree un sistema que pueda escalar para admitir grandes cantidades de usuarios concurrentes sin comprometer el rendimiento.
5. Personalización : permita a las instituciones y educadores adaptar la plataforma a sus necesidades específicas.

Tabla de contenido

• Características
• Estructura de proyectos
• Instrucciones de configuración
• Que contribuye

Características

• Frontend : construido con React, configurado con VITE para una construcción más rápida y experiencia de desarrollo optimizado.
• Backend : alimentado por Node.js con un servidor API.
• Comunicación en tiempo real : admite videoconferencia en vivo y chat usando WebRTC y Socket.io.
• Herramientas interactivas : incluye una pizarra compartida para la colaboración durante las clases.
• Autenticación segura : implementa el inicio de sesión seguro y la gestión de usuarios.
• Diseño receptivo : garantiza la usabilidad entre dispositivos, incluidos computadoras de escritorio, tabletas y teléfonos inteligentes.
• Integración de FullStack : Frontend y backend conectados sin problemas para un manejo de datos eficiente.

Estructura de proyectos

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

Instrucciones de configuración

Requisitos previos

• Node.js y npm instalados en su máquina.

1. Clonar el repositorio

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

2. Instalar dependencias

Navegue a las carpetas del cliente y del servidor para instalar las dependencias necesarias.

Interfaz

 cd client
npm install

Backend

 cd ../server
npm install

3. Configurar variables de entorno

Cree un archivo .env en el directorio server y agregue las variables de entorno requeridas, como cadenas de conexión de base de datos, claves API y otras configuraciones.

4. Inicie la aplicación

Servidor de fondo

Para iniciar el servidor de backend, ejecute el siguiente comando desde la carpeta server :

npm run dev

Esto iniciará el servidor de backend en modo de desarrollo.

Servidor frontend

Para iniciar el servidor frontend, ejecute el siguiente comando desde la carpeta client :

npm run dev

5. Acceda a la aplicación

Una vez que se ejecutan los servidores frontend y backend, puede acceder a la aplicación en http://localhost:5173 de forma predeterminada.

Que contribuye

¡Agradecemos las contribuciones! Para contribuir, siga estos pasos:

1. Bifurca el repositorio y crea su rama:

   git checkout -b feature/YourFeature

2. Realice sus cambios y confídos con un mensaje significativo:

   git commit -m " Add YourFeature "

3. Empuje a su horquilla y envíe una solicitud de extracción:

   git push origin feature/YourFeature

4. Envíe una solicitud de extracción de su repositorio bifurcado a la rama main del repositorio principal. Nuestro equipo revisará su solicitud de extracción y sugerirá cualquier cambio necesario.

Pautas de desarrollo

• Asegurar la consistencia y la legibilidad del código.
• Escribe mensajes de confirmación significativo.
• Pruebe sus cambios antes de enviar una solicitud de extracción.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.

---