README_zh_CN.md

openim-chat

📄 源代码的许可选项

您可以在以下两种许可选项之一下使用 OpenIM 源代码来创建非 OpenIM 原始生产的编译版本：

1. 通用公共许可证 v3.0 (GPLv3) 🆓

• 该选项受自由软件基金会的 GPL v3.0 管理。
• 使用受此政策概述的某些例外的约束。

2. 商业许可 💼

• 通过联系 OpenIM 获得商业许可。
• 有关详细信息和许可查询，请通过电子邮件 📧 [email protected]。

🧩 功能简介

1. 该仓库实现了业务系统，包括两部分：用户系统和后台管理系统。
2. 该系统依赖于 open-im-server 仓库，通过调用即时消息系统的 API 实现丰富的业务功能。
3. 用户系统包括一些常规功能，如用户登录、用户注册、用户信息更新等。
4. 后台管理系统包括提供了 API 管理用户、群组和消息等。

👥 社区

• 💬 关注我们的 Twitter 账户
• 🚀 加入我们的 Slack 社区
• 👀 加入我们的微信群

🛫 快速开始

⚠️ 注意：本项目在 Linux/Windows/Mac 平台以及 ARM 和 AMD 架构下均可正常使用

📦 克隆

git clone https://github.com/openimsdk/chat openim-chat
cd openim-chat

🛠 初始化

💻 第一次编译前，Linux/Mac 平台下执行：

sh bootstrap.sh

💻 Windows 执行：

bootstrap.bat

🏗 编译

mage

🚀 启动

mage start

💾 或后台启动 收集日志

nohup mage start >> _output/logs/chat.log 2>&1 &

🔎 检测

mage check

🛑 停止

mage stop

🚀 启动顺序

1. 成功启动 open-im-server。
2. 编译 chat mage。
3. 启动 chat mage start。

📞 如果您想启用音视频通话，请配置 LiveKit

🔗 请参考 "如何设置 LiveKit 服务器"。

🤝 贡献

❤️ 欢迎对该项目做出贡献！请查看 CONTRIBUTING.md 了解详情。

🚨 许可

📜 chat 根据 GPL-3.0 license 许可证授权。查看 LICENSE 获取完整的许可证文本。