mirror of
				https://github.com/openimsdk/open-im-server.git
				synced 2025-10-25 04:32:10 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			140 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			140 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| <p align="center">
 | ||
|     <a href="https://openim.io">
 | ||
|         <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
 | ||
|     </a>
 | ||
| </p>
 | ||
| 
 | ||
| <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-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A)
 | ||
| [](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/)
 | ||
| 
 | ||
| <p align="center">
 | ||
|   <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>
 | ||
| </p>
 | ||
| 
 | ||
| </div>
 | ||
| 
 | ||
| </p>
 | ||
| 
 | ||
| ## :busts_in_silhouette: 加入我们的社区
 | ||
| 
 | ||
| - 💬 [关注我们的 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)
 | ||
| 
 | ||
| ## Ⓜ️ 关于 OpenIM
 | ||
| 
 | ||
| 与 Telegram、Signal、Rocket.Chat 等独立聊天应用不同,OpenIM 提供了专为开发者设计的开源即时通讯解决方案,而不是直接安装使用的独立聊天应用。OpenIM 由 OpenIM SDK 和 OpenIM Server 两大部分组成,为开发者提供了一整套集成即时通讯功能的工具和服务,包括消息发送接收、用户管理和群组管理等。总体来说,OpenIM 旨在为开发者提供必要的工具和框架,帮助他们在自己的应用中实现高效的即时通讯解决方案。
 | ||
| 
 | ||
| 
 | ||
| 
 | ||
| ## 🚀 OpenIMSDK 介绍
 | ||
| 
 | ||
| **OpenIMSDK** 是为 **OpenIMServer** 设计的 IM SDK,专为集成到客户端应用而生。它支持多种功能和模块:
 | ||
| 
 | ||
| - 🌟 主要功能:
 | ||
| 
 | ||
|   - 📦 本地存储
 | ||
|   - 🔔 监听器回调
 | ||
|   - 🛡️ API 封装
 | ||
|   - 🌐 连接管理
 | ||
| 
 | ||
| - 📚 主要模块:
 | ||
|   1. 🚀 初始化及登录
 | ||
|   2. 👤 用户管理
 | ||
|   3. 👫 好友管理
 | ||
|   4. 🤖 群组功能
 | ||
|   5. 💬 会话处理
 | ||
| 
 | ||
| 它使用 Golang 构建,并支持跨平台部署,确保在所有平台上提供一致的接入体验。
 | ||
| 
 | ||
| 👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 | ||
| 
 | ||
| ## 🌐 OpenIMServer 介绍
 | ||
| 
 | ||
| - **OpenIMServer** 的特点包括:
 | ||
|   - 🌐 微服务架构:支持集群模式,包括网关(gateway)和多个 rpc 服务。
 | ||
|   - 🚀 多样的部署方式:支持源代码、Kubernetes 或 Docker 部署。
 | ||
|   - 海量用户支持:支持十万级超大群组,千万级用户和百亿级消息。
 | ||
| 
 | ||
| ### 增强的业务功能:
 | ||
| 
 | ||
| - **REST API**:为业务系统提供 REST API,增加群组创建、消息推送等后台接口功能。
 | ||
| 
 | ||
| - **Webhooks**:通过事件前后的回调,向业务服务器发送请求,扩展更多的业务形态。
 | ||
| 
 | ||
|   
 | ||
| 
 | ||
| ## :rocket: 快速入门
 | ||
| 
 | ||
| 在线体验 iOS/Android/H5/PC/Web:
 | ||
| 
 | ||
| 👉 **[OpenIM 在线演示](https://www.openim.io/en/commercial)**
 | ||
| 
 | ||
| 为了便于用户体验,我们提供了多种部署解决方案,您可以根据以下列表选择适合您的部署方式:
 | ||
| 
 | ||
| - **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
 | ||
| - **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
 | ||
| 
 | ||
| ## 系统支持
 | ||
| 
 | ||
| 支持 Linux、Windows、Mac 系统以及 ARM 和 AMD CPU 架构。
 | ||
| 
 | ||
| ## :link: 相关链接
 | ||
| 
 | ||
| - **[开发手册](https://docs.openim.io/)**
 | ||
| - **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
 | ||
| 
 | ||
| ## :writing_hand: 如何贡献
 | ||
| 
 | ||
| 我们欢迎任何形式的贡献!在提交 Pull Request 之前,请确保阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)
 | ||
| 
 | ||
| - **[报告 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)**
 | ||
| 
 | ||
| 感谢您的贡献,一起来打造强大的即时通讯解决方案!
 | ||
| 
 | ||
| ## :closed_book: 开源许可证 License
 | ||
| 
 | ||
| This software is licensed under the Apache License 2.0
 | ||
| 
 | ||
| ## 🔮 Thanks to our contributors!
 | ||
| 
 | ||
| <a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
 | ||
|   <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
 | ||
| </a>
 |