# OkEDU-Classroom-Desktop
**Repository Path**: gaojie/ok-edu-classroom-desktop
## Basic Information
- **Project Name**: OkEDU-Classroom-Desktop
- **Description**: OkEDU-Classroom-Desktop
- **Primary Language**: C++
- **License**: MulanPubL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 19
- **Created**: 2022-09-14
- **Last Updated**: 2023-05-24
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
👑 OkEDU-Classroom-Desktop 👑
# 🎁 项目介绍
**OkEDU Classroom 是基于“互联网+教育”理念， 解决在线上课问题而研发的互动教室，是实时、高效、功能完备的上课工具，本软件基于浏览器实时多媒体标准 WebRTC 以及即时通讯协议 XMPP 实现，具备很好的通用性、拓展性、移植性。**
# 🧭 功能介绍
实现在线教室互动，包含：课程信息、互动白板、视频直播、交流互动、在线群聊、文件传输等。
# 🏢 软件架构
# 🖼️ 界面展示
> 登录界面
> 主界面
> 白板界面
> 聊天界面
> 新的聊天窗口
# ⛽ 第三方库
- CMake ([New BSD License](https://github.com/Kitware/CMake/blob/master/Copyright.txt))
- WebRTC ([New BSD License](https://github.com/desktop-app/tg_owt/blob/master/LICENSE))
- OpenSSL 3.0.x ([OpenSSL License](https://www.openssl.org/source/license.html))
- qTox([GPL v3](https://github.com/qTox/qTox/LICENSE))
- gloox ([GPL v3](https://gitee.com/chuanshantech/ok-edu-gloox))
- OpenAL Soft ([LGPL](https://github.com/kcat/openal-soft/blob/master/COPYING))
- FFmpeg ([LGPL](https://www.ffmpeg.org/legal.html))
- Qt 5.15 ([LGPL](http://doc.qt.io/qt-5/lgpl.html))
- QtAV ([Copyright © Wang Bin wbsecg1@gmail.com](https://github.com/wang-bin/QtAV))
- zlib ([zlib License](http://www.zlib.net/zlib_license.html))
- Sqlite3 ([Public Domain](https://sqlite.org/copyright.html))
- Sodium([ISC license.](https://github.com/jedisct1/libsodium))
- libexif([GPL v2](https://github.com/libexif/libexif/blob/master/COPYING))
- libqrencode([GPL v2+](https://github.com/fukuchi/libqrencode))
# 🖥️ 支持平台
> 🐧 Linux
- Ubuntu 已支持 文档：[Build On Ubuntu](./docs/BUILD-linux.md "Linux 构建")
- Fedora 计划中
- 欧拉 计划中
- 麒麟 计划中
- 统信 计划中
> 🪟 Windows
- Windows10+ 已支持 文档：[Build On Windows](./docs/building/BUILD-win.md "Windows 构建")。
> 🍎 macOS
- 计划中 查看[Build On macOS](./docs/building/BUILD-macos.md "MacOS 构建")文档。
# 🧰 编译环境
- ✅ 支持 **GCC On Linux**
- ✅ 支持 **Clang On Linux**
- ✅ 支持 **MSVC On Windows**
- ✅ 支持 **Clang On Windows**
- 📌 支持 **MinGW On Windows** 计划中
- 📌 支持 **Clang On macOS** 计划中
# ⚙️ 构建开发
✔️支持**静态编译**。
❌不支持**动态编译**；
> 构建本项目需要分如下几步：
1. 准备工具链环境：[Linux](./docs/building/ToolChain-linux.md) | [Windows](./docs/building/ToolChain-win.md) | [macOS](./docs/building/ToolChain-macos.md) 计划中
2. 准备Qt静态环境：[Linux](./docs/building/Qt-linux.md) | [Windows](./docs/building/Qt-win.md) | [macOS](./docs/building/BUILD-macos.md) 计划中
3. 准备第三方包依赖：[Linux](./docs/building/ThirdPart-linux.md) | [Windows](./docs/building/ThirdPart-win.md) | [macOS](./docs/building/ThirdPart-macos.md) 计划中
4. 下载源代码：`git clone https://gitee.com/chuanshantech/ok-edu-classroom-desktop.git`
5. IDE开发： [VS Code](./docs/building/IDE-vscode.md) | [VS Studio](./docs/building/IDE-vsstudio.md) | [QtCreator](./docs/building/IDE-qtcreator.md) | [Clion](./docs/building/IDE-clion.md)
> 使用【**CMake**】构建
```shell
# 到项目根目录下
cd ${dir}\ok-edu-classroom-desktop
#输出到../build目录
cmake -S . -B ../build # Windows增加参数 -DCMAKE_BUILD_TYPE=Release
#构建
cmake --build ../build # Windows增加参数 --config Release
#输出如下信息则成功
正在创建库 E:/QtWorkspace/build/Release/OkEDU-Classroom-Desktop.lib 和对象 E:/QtWorkspace/build/Release/OkEDU-Classroom-Desktop.exp
OkEDU-Classroom-Desktop.vcxproj -> E:\QtWorkspace\build\Release\OkEDU-Classroom-Desktop.exe
Building Custom Rule E:/QtWorkspace/ok-edu-classroom-desktop/CMakeLists.txt
```
# ⚒️ 开发规范
- Git [Git规范](./docs/spec/git.md)
- Format [代码格式化](./docs/spec/format.md)
# 🙏 感谢支持
- [感谢 JetBrains 对本项目的支持（Drive by JetBrains）](https://jb.gg/OpenSourceSupport) 
# ❤️ 捐赠方式
> 您的捐款是OkEDU开源项目持续前进的动力，希望该项目可以让任何人从中受益。
> 捐赠列表 https://kdocs.cn/l/cr7rVyXnbxuK
> 欢迎大家 Clone 本项目，捐赠收入将用于对贡献者的奖励。
# ⏰ 任务列表
> 【金山文档】 OkEDU任务列表 https://kdocs.cn/l/csib86aYwx0P
# ☎️ 联系我们
> 技术交流群，添加微信：**chuanshantech**（备注：OkEDU+姓名）
> 微信公众号，关注账号：**OkEDU**
# ©️ 许可协议
- 国际：**[GPL-2.0](https://opensource.org/license/gpl-2-0/)**
- 中国：**[木兰公共许可证, 第2版](https://opensource.org/license/mulanpsl-2-0/)**
