EduMatrix Virtual Classroom

フルスタックプロジェクト

このプロジェクトは、React（FrontEnd）およびNode.js（BackEnd）で構築されたフルスタックWebアプリケーションです。フロントエンドはViteで構成され、 clientフォルダーにあり、バックエンドサーバーはnode.jsで実行され、 npm run devで開始できます。

プロジェクトについて

Edumatrixは、シームレスでインタラクティブな学習体験を提供するように設計された仮想教室プラットフォームです。 Mern Stackで構築され、socket.ioとWebrtcを使用してリアルタイム通信機能を統合して、ライブクラス、ビデオ会議、共有ホワイトボードやチャットなどの共同ツールを有効にします。

目標

1. オンライン教育の強化：従来の教室と仮想学習の間のギャップを埋めるプラットフォームを提供し、学生と教育者の両方に豊かでインタラクティブな体験を確保します。
2. アクセシビリティ：信頼できるユーザーフレンドリーなプラットフォームを提供することにより、世界中のユーザーが教育にアクセスできるようにします。
3. リアルタイムの相互作用：ビデオ会議、チャット、インタラクティブツールを通じて、教師と学生の間の効果的なコミュニケーションとコラボレーションを促進します。
4. スケーラビリティ：パフォーマンスを損なうことなく、多数の同時ユーザーをサポートするためにスケーリングできるシステムを構築します。
5. カスタマイズ：機関と教育者が特定のニーズに合わせてプラットフォームを調整できるようにします。

目次

• 特徴
• プロジェクト構造
• セットアップ手順
• 貢献

特徴

• FrontEnd ：Viteで構成されたReactで構築されており、より速いビルドと最適化された開発エクスペリエンスのために構成されています。
• バックエンド：APIサーバーを使用してnode.jsを搭載しています。
• リアルタイムコミュニケーション：Webrtcとsocket.ioを使用したライブビデオ会議とチャットをサポートします。
• インタラクティブツール：クラス中のコラボレーション用の共有ホワイトボードが含まれています。
• 安全な認証：安全なログインとユーザー管理を実装します。
• レスポンシブデザイン：デスクトップ、タブレット、スマートフォンなど、デバイス間での使いやすさが保証されます。
• フルスタックの統合：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.環境変数を構成します

serverディレクトリに.envファイルを作成し、データベース接続文字列、APIキー、その他の構成など、必要な環境変数を追加します。

4。アプリケーションを開始します

バックエンドサーバー

バックエンドサーバーを起動するには、 serverフォルダーから次のコマンドを実行します。

npm run dev

これにより、開発モードでバックエンドサーバーが開始されます。

フロントエンドサーバー

フロントエンドサーバーを起動するには、 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ライセンスに基づいてライセンスされています。詳細については、ライセンスファイルを参照してください。

---