EduMatrix Virtual Classroom

Fullstack Project

Этот проект представляет собой веб -приложение Fullstack, созданное с React (Frontend) и Node.js (Backend). Frontend настроен с Vite и расположен в папке client , в то время как сервер бэкэнд запускается с Node.js и может быть запущен с npm run dev .

О проекте

Edumatrix - это виртуальная платформа класса, предназначенная для обеспечения бесшовного и интерактивного обучения. Созданный со стеком Mern, он интегрирует функции связи в реальном времени с использованием Socket.io и Webrtc, чтобы включить живые занятия, видеоконференции и инструменты для совместной работы, такие как общая доска и чат.

Цели

1. Улучшение онлайн -образования : предоставьте платформу, которая преодолевает разрыв между традиционными классами и виртуальным обучением, обеспечивая богатый и интерактивный опыт как для студентов, так и для преподавателей.
2. Доступность : сделать образование доступным для пользователей по всему миру, предлагая надежную и удобную платформу.
3. Взаимодействие в реальном времени : облегчить эффективное общение и сотрудничество между учителями и учениками с помощью видеоконференций, чата и интерактивных инструментов.
4. Масштабируемость : создайте систему, которая может масштабироваться для поддержки большого количества одновременных пользователей без ущерба для производительности.
5. Настройка : позволяйте учреждениям и преподавателям адаптировать платформу к их конкретным потребностям.

Оглавление

• Функции
• Структура проекта
• Инструкции по настройке
• Внося

Функции

• Frontend : построен с React, настроенным с Vite для более быстрого построения и оптимизированного опыта разработки.
• Бэкэнд : питание от Node.js с сервером API.
• Общение в реальном времени : поддерживает живые видеоконференции и чат с использованием webrtc и socket.io.
• Интерактивные инструменты : включает в себя общую доску для сотрудничества во время занятий.
• Безопасная аутентификация : реализует безопасный вход и управление пользователями.
• Адаптивный дизайн : обеспечивает юзабилити между устройствами, включая настольные компьютеры, планшеты и смартфоны.
• Интеграция FullStack : Frontend и Backend подключены к бесшовной подключению для эффективной обработки данных.

Структура проекта

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

Инструкции по настройке

Предварительные условия

• Node.js и NPM установлены на вашей машине.

1. Клонировать репозиторий

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

2. Установите зависимости

Перейдите к папкам клиента и сервера, чтобы установить необходимые зависимости.

Внешний интерфейс

 cd client
npm install

Бэкэнд

 cd ../server
npm install

3. Настройка переменных среды

Создайте файл .env в каталоге server и добавьте любые необходимые переменные среды, такие как строки подключения базы данных, клавиши API и другие конфигурации.

4. Начните приложение

Бэкэнд -сервер

Чтобы запустить бэкэнд -сервер, запустите следующую команду из папки server :

npm run dev

Это запустит бэкэнд -сервер в режиме разработки.

Frontend Server

Чтобы запустить сервер Frontend, запустите следующую команду из client папки:

npm run dev

5. Доступ к приложению

После того, как запускаются как серверы, так и бэкэнд, вы можете получить доступ к приложению по адресу http://localhost:5173 по умолчанию.

Внося

Мы приветствуем вклад! Чтобы внести свой вклад, следуйте этим шагам:

1. Разветвляется хранилище и создайте свою ветвь:

   git checkout -b feature/YourFeature

2. Внесите свои изменения и совершите их со значимым сообщением:

   git commit -m " Add YourFeature "

3. Нажмите на свою вилку и отправьте запрос на вытягивание:

   git push origin feature/YourFeature

4. Отправьте запрос на притяжение из вашего раздвоенного хранилища в main филиал главного хранилища. Наша команда рассмотрит ваш запрос на привлечение и предложит любые необходимые изменения.

Руководящие принципы развития

• Обеспечить согласованность и читаемость кода.
• Напишите значимые сообщения о коммите.
• Проверьте свои изменения, прежде чем отправить запрос на привлечение.

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.

---