2023-08-23 09:09:51 +08:00
<p align="center">
2023-10-30 10:16:37 +08:00
<a href="https://openim.io">
2023-08-23 09:09:51 +08:00
<img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
</a>
</p>
2024-02-02 19:47:16 +08:00
<div align="center">
[](https://github.com/openimsdk/open-im-server/stargazers)
[](https://github.com/openimsdk/open-im-server/network/members)
[](https://app.codecov.io/gh/openimsdk/open-im-server)
[](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
[](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
[](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
[](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
[](https://www.bestpractices.dev/projects/8045)
[](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
[](https://golang.org/)
2023-06-01 23:59:16 +08:00
<p align="center">
2024-02-02 19:47:16 +08:00
<a href="./README.md">Englist</a> ·
2024-02-07 21:52:38 +08:00
<a href="./README_zh_CN.md">中文</a> ·
<a href="./docs/readme/README_uk.md">Українська</a> ·
<a href="./docs/readme/README_cs.md">Česky</a> ·
<a href="./docs/readme/README_hu.md">Magyar</a> ·
<a href="./docs/readme/README_es.md">Español</a> ·
<a href="./docs/readme/README_fa.md">فارسی</a> ·
<a href="./docs/readme/README_fr.md">Français</a> ·
<a href="./docs/readme/README_de.md">Deutsch</a> ·
<a href="./docs/readme/README_pl.md">Polski</a> ·
<a href="./docs/readme/README_id.md">Indonesian</a> ·
<a href="./docs/readme/README_fi.md">Suomi</a> ·
<a href="./docs/readme/README_ml.md">മലയാളം</a> ·
<a href="./docs/readme/README_ja.md">日本語</a> ·
<a href="./docs/readme/README_nl.md">Nederlands</a> ·
<a href="./docs/readme/README_it.md">Italiano</a> ·
<a href="./docs/readme/README_ru.md">Русский</a> ·
<a href="./docs/readme/README_pt_BR.md">Português (Brasil)</a> ·
<a href="./docs/readme/README_eo.md">Esperanto</a> ·
<a href="./docs/readme/README_ko.md">한국어</a> ·
<a href="./docs/readme/README_ar.md">العربي</a> ·
<a href="./docs/readme/README_vi.md">Tiếng Việt</a> ·
<a href="./docs/readme/README_da.md">Dansk</a> ·
<a href="./docs/readme/README_el.md">Ελληνικά</a> ·
<a href="./docs/readme/README_tr.md">Türkçe</a>
2023-06-01 23:59:16 +08:00
</p>
2023-08-23 09:09:51 +08:00
2024-02-02 19:47:16 +08:00
</div>
2023-06-01 23:59:16 +08:00
</p>
2023-11-10 08:44:36 +08:00
## 🟢 扫描微信进群交流
2024-04-02 11:31:25 +08:00
<img src="./docs/images/wechat.jpg" width="300">
2023-11-10 08:44:36 +08:00
2023-10-12 17:29:26 +08:00
## Ⓜ️ 关于 OpenIM
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
OpenIM 是一个专门设计用于在应用程序中集成聊天、音视频通话、通知以及AI聊天机器人等通信功能的服务平台。它通过提供一系列强大的API和Webhooks，使开发者可以轻松地在他们的应用中加入这些交互特性。OpenIM 本身并不是一个独立运行的聊天应用，而是作为一个平台，为其他应用提供支持，实现丰富的通信功能。下图展示 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 之间的交互关系来具体说明。
2023-10-12 17:29:26 +08:00
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
## 🚀 关于 OpenIMSDK
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
**OpenIMSDK ** 是为 **OpenIMServer ** 设计的IM SDK，专为嵌入客户端应用而生。其主要功能及模块如下：
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
+ 🌟 主要功能：
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
- 📦 本地存储
- 🔔 监听器回调
- 🛡️ API封装
- 🌐 连接管理
## 📚 主要模块：
1. 🚀 初始化及登录
2. 👤 用户管理
3. 👫 好友管理
4. 🤖 群组功能
5. 💬 会话处理
它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的接入体验。
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
👉 * * [探索 GO SDK ](https://github.com/openimsdk/openim-sdk-core )**
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
## 🌐 关于 OpenIMServer
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
+ **OpenIMServer ** 具有以下特点：
- 🌐 微服务架构：支持集群模式，包括网关(gateway)和多个rpc服务。
- 🚀 部署方式多样：支持源代码、kubernetes或docker部署。
- 海量用户支持：十万超级大群，千万用户，及百亿消息
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
### 增强的业务功能：
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
+ **REST API ** ：
+ **Webhooks ** ：
2023-08-23 09:09:51 +08:00
2024-01-08 21:40:04 +08:00
👉 * * [了解更多 ](https://docs.openim.io/guides/introduction/product )**
2023-08-23 09:09:51 +08:00
## :rocket: 快速开始
2024-01-08 21:40:04 +08:00
在线体验iOS/Android/H5/PC/Web：
2023-06-01 23:59:16 +08:00
2024-01-08 21:40:04 +08:00
👉 * * [OpenIM online demo ](https://www.openim.io/zh/commercial )**
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
2023-06-01 23:59:16 +08:00
2024-01-08 21:40:04 +08:00
+ * * [源代码部署指南 ](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment )**
+ * * [Docker 部署指南 ](https://docs.openim.io/guides/gettingStarted/dockerCompose )**
+ * * [Kubernetes 部署指南 ](https://docs.openim.io/guides/gettingStarted/k8s-deployment )**
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
## :hammer_and_wrench: 开始开发 OpenIM
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在[社区仓库 ](https://github.com/OpenIMSDK/community )中。
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
如果你想为这个 Open-IM-Server 仓库做贡献，请阅读我们的[贡献者文档 ](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md )。
2023-08-23 09:09:51 +08:00
2023-10-12 17:29:26 +08:00
在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论 ](https://github.com/openimsdk/open-im-server/discussions/new/choose ) 或 [Slack 通信 ](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q )，或者如果你发现一个问题，首先[报告它 ](https://github.com/openimsdk/open-im-server/issues/new/choose )。
2023-08-23 09:09:51 +08:00
2023-11-10 19:37:25 +08:00
+ [代码标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md )
2023-08-23 09:09:51 +08:00
2023-11-10 19:37:25 +08:00
+ [Docker 镜像标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md )
2023-07-17 21:18:34 +08:00
2023-11-10 19:37:25 +08:00
+ [目录标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md )
2023-07-17 20:59:25 +08:00
2023-11-10 19:37:25 +08:00
+ [提交标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md )
2023-06-01 23:59:16 +08:00
2023-11-10 19:37:25 +08:00
+ [版本控制标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md )
2023-06-01 23:59:16 +08:00
2023-11-10 19:37:25 +08:00
+ [接口标准 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/interface.md )
2023-06-01 23:59:16 +08:00
2023-10-21 15:23:33 +08:00
+ [OpenIM配置和环境变量设置 ](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md )
> **Note**
2023-11-10 19:37:25 +08:00
> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
2023-10-21 15:23:33 +08:00
2023-10-12 17:29:26 +08:00
## :link: 链接
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
+ * * [完整文档 ](https://doc.rentsoft.cn/ )**
+ * * [更新日志 ](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md )**
+ * * [FAQ ](https://github.com/openimsdk/open-im-server/blob/main/FAQ.md )**
+ * * [代码示例 ](https://github.com/openimsdk/open-im-server/blob/main/examples )**
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
## :handshake: 社区
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
+ * * [GitHub Discussions ](https://github.com/openimsdk/open-im-server/discussions )**
+ * * [Slack 通信 ](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q )**
+ * * [GitHub Issues ](https://github.com/openimsdk/open-im-server/issues )**
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
您可以加入这些平台，讨论问题，提出建议，或分享您的成功故事！
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
## :writing_hand: 贡献
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
我们欢迎任何形式的贡献！请确保在提交 Pull Request 之前阅读我们的[贡献者文档 ](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md )。
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
+ * * [报告 Bug ](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title= )**
+ * * [提出新特性 ](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title= )**
+ * * [提交 Pull Request ](https://github.com/openimsdk/open-im-server/pulls )**
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
感谢您的贡献，我们一起打造一个强大的即时通信解决方案！
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
## :closed_book: 许可证
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
OpenIMSDK 在 Apache License 2.0 许可下可用。查看[LICENSE 文件 ](https://github.com/openimsdk/open-im-server/blob/main/LICENSE )了解更多信息。
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
## 🔮 Thanks to our contributors!
2023-06-01 23:59:16 +08:00
2023-10-12 17:29:26 +08:00
<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
</a>
