Files

140 lines
7.1 KiB
Markdown
Raw Permalink Normal View History

<p align="center">
2023-10-30 10:16:37 +08:00
<a href="https://openim.io">
<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">
[![Stars](https://img.shields.io/github/stars/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=ff69b4)](https://github.com/openimsdk/open-im-server/stargazers)
[![Forks](https://img.shields.io/github/forks/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=blue)](https://github.com/openimsdk/open-im-server/network/members)
[![Codecov](https://img.shields.io/codecov/c/github/openimsdk/open-im-server?style=for-the-badge&logo=codecov&colorB=orange)](https://app.codecov.io/gh/openimsdk/open-im-server)
[![Go Report Card](https://goreportcard.com/badge/github.com/openimsdk/open-im-server?style=for-the-badge)](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
[![Go Reference](https://img.shields.io/badge/Go%20Reference-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge)](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
2025-07-28 10:46:23 +08:00
[![Slack](https://img.shields.io/badge/Slack-500%2B-blueviolet?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/openimsdk/shared_invite/zt-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A)
2024-02-02 19:47:16 +08:00
[![Best Practices](https://img.shields.io/badge/Best%20Practices-purple?style=for-the-badge)](https://www.bestpractices.dev/projects/8045)
[![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)
2023-06-01 23:59:16 +08:00
<p align="center">
2024-07-24 14:50:02 +08:00
<a href="./README.md">English</a> ·
<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>
2024-02-02 19:47:16 +08:00
</div>
2023-06-01 23:59:16 +08:00
</p>
2024-04-25 14:21:32 +08:00
## :busts_in_silhouette: 加入我们的社区
2023-11-10 08:44:36 +08:00
2025-07-28 10:46:23 +08:00
- 💬 [关注我们的 Twitter](https://twitter.com/founder_im63606)
- 🚀 [加入我们的 Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-2hljfom5u-9ZuzP3NfEKW~BJKbpLm0Hw)
- :eyes: [加入我们的微信群](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
2023-11-10 08:44:36 +08:00
## Ⓜ️ 关于 OpenIM
2025-07-28 10:46:23 +08:00
与 Telegram、Signal、Rocket.Chat 等独立聊天应用不同,OpenIM 提供了专为开发者设计的开源即时通讯解决方案,而不是直接安装使用的独立聊天应用。OpenIM 由 OpenIM SDK 和 OpenIM Server 两大部分组成,为开发者提供了一整套集成即时通讯功能的工具和服务,包括消息发送接收、用户管理和群组管理等。总体来说,OpenIM 旨在为开发者提供必要的工具和框架,帮助他们在自己的应用中实现高效的即时通讯解决方案。
2024-01-08 21:40:04 +08:00
![App-OpenIM 关系](./docs/images/oepnim-design.png)
2024-04-25 14:21:32 +08:00
## 🚀 OpenIMSDK 介绍
2025-07-28 10:46:23 +08:00
**OpenIMSDK** 是为 **OpenIMServer** 设计的 IM SDK,专为集成到客户端应用而生。它支持多种功能和模块:
- 🌟 主要功能:
2024-01-08 21:40:04 +08:00
- 📦 本地存储
- 🔔 监听器回调
2025-07-28 10:46:23 +08:00
- 🛡️ API 封装
2024-01-08 21:40:04 +08:00
- 🌐 连接管理
2025-07-28 10:46:23 +08:00
- 📚 主要模块:
2024-01-08 21:40:04 +08:00
1. 🚀 初始化及登录
2. 👤 用户管理
3. 👫 好友管理
4. 🤖 群组功能
5. 💬 会话处理
它使用 Golang 构建,并支持跨平台部署,确保在所有平台上提供一致的接入体验。
👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
2024-04-25 14:21:32 +08:00
## 🌐 OpenIMServer 介绍
2025-07-28 10:46:23 +08:00
- **OpenIMServer** 的特点包括:
- 🌐 微服务架构:支持集群模式,包括网关(gateway)和多个 rpc 服务。
- 🚀 多样的部署方式:支持源代码、Kubernetes 或 Docker 部署。
2024-04-25 14:21:32 +08:00
- 海量用户支持:支持十万级超大群组,千万级用户和百亿级消息。
### 增强的业务功能:
2025-07-28 10:46:23 +08:00
- **REST API**:为业务系统提供 REST API,增加群组创建、消息推送等后台接口功能。
2024-04-25 14:21:32 +08:00
2025-07-28 10:46:23 +08:00
- **Webhooks**:通过事件前后的回调,向业务服务器发送请求,扩展更多的业务形态。
2024-04-25 14:21:32 +08:00
![整体架构](./docs/images/architecture-layers.png)
2024-04-25 14:21:32 +08:00
## :rocket: 快速入门
2025-07-28 10:46:23 +08:00
在线体验 iOS/Android/H5/PC/Web
2023-06-01 23:59:16 +08:00
2025-07-28 10:46:23 +08:00
👉 **[OpenIM 在线演示](https://www.openim.io/en/commercial)**
2023-06-01 23:59:16 +08:00
2024-04-25 14:21:32 +08:00
为了便于用户体验,我们提供了多种部署解决方案,您可以根据以下列表选择适合您的部署方式:
2023-06-01 23:59:16 +08:00
2025-07-28 10:46:23 +08:00
- **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
- **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
2024-04-25 14:21:32 +08:00
## 系统支持
2024-04-25 14:21:32 +08:00
支持 Linux、Windows、Mac 系统以及 ARM 和 AMD CPU 架构。
2024-04-25 14:21:32 +08:00
## :link: 相关链接
2025-07-28 10:46:23 +08:00
- **[开发手册](https://docs.openim.io/)**
- **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
2023-06-01 23:59:16 +08:00
2024-04-25 14:21:32 +08:00
## :writing_hand: 如何贡献
2023-06-01 23:59:16 +08:00
2024-04-25 14:21:32 +08:00
我们欢迎任何形式的贡献!在提交 Pull Request 之前,请确保阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)
2023-06-01 23:59:16 +08:00
2025-07-28 10:46:23 +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
2024-04-25 14:21:32 +08:00
感谢您的贡献,一起来打造强大的即时通讯解决方案!
2023-06-01 23:59:16 +08:00
2025-07-28 10:46:23 +08:00
## :closed_book: 开源许可证 License
2025-04-22 16:48:12 +08:00
2025-04-22 21:52:32 +08:00
This software is licensed under the Apache License 2.0
2023-06-01 23:59:16 +08:00
## 🔮 Thanks to our contributors!
2023-06-01 23:59:16 +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>