即时通讯IM
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
chao 80a46b329d
feat: provide the interface required by js sdk (#2664)
3 months ago
.github Test Workflow (#2640) 3 months ago
CHANGELOG/.chglog merge 7 months ago
assets feat: Enhance Script Details and Add MacOS Compatibility with Documentation Updates (#1794) 11 months ago
build refactor: 3.7.0 code conventions. (#2148) 8 months ago
cmd feat: new features merged (#2409) 5 months ago
config Fix token (#2653) 3 months ago
deployments merge: fix some typos in comments 5 months ago
docs docs: fix english typo (#2432) 5 months ago
internal feat: provide the interface required by js sdk (#2664) 3 months ago
pkg feat: provide the interface required by js sdk (#2664) 3 months ago
scripts feat: improve searchMsg implement. (#2614) 3 months ago
test refactor: update Userregister request field. (#2650) 3 months ago
tools feat: implement offline push using kafka (#2600) 4 months ago
version feat: update webhookBeforeMemberJoinGroup to batch method. (#2459) 5 months ago
.dockerignore 3.6.1 code conventions (#2202) 8 months ago
.env feat: update web front images (#2487) 5 months ago
.gitattributes remove \r 8 months ago
.gitignore feat: new features merged (#2409) 5 months ago
.golangci.yml refactor: refactor workflows structure. (#2511) 4 months ago
CHANGELOG.md feat: add link file 1 year ago
CODE_OF_CONDUCT.md Feat/add test scripts (#1341) 1 year ago
CONTRIBUTING-zh_CN.md Fix: solve conversation blocking in private chat when non friendship. (#2542) 4 months ago
CONTRIBUTING.md Fix: solve conversation blocking in private chat when non friendship. (#2542) 4 months ago
Dockerfile update gomake version (#2386) 6 months ago
LICENSE v3 - main to cut out 2 years ago
README.md docs: fix english typo (#2432) 5 months ago
README_zh_CN.md docs: fix english typo (#2432) 5 months ago
bootstrap.bat refactor: 3.7.0 code conventions. (#2148) 8 months ago
bootstrap.sh 3.6.1 code conventions (#2202) 8 months ago
docker-compose.yml fix: the attribute version is obsolete, remove it (#2644) 3 months ago
go.mod feat: provide the interface required by js sdk (#2664) 3 months ago
go.sum feat: provide the interface required by js sdk (#2664) 3 months ago
install.sh fix: reconstruct the script of 'make start' 'make stop' and 'make check' (#1953) 10 months ago
magefile.go Skip minio check (#2281) 8 months ago
magefile_unix.go refactor: 3.7.0 code conventions. (#2148) 8 months ago
magefile_windows.go refactor: 3.7.0 code conventions. (#2148) 8 months ago
start-config.yml Fix err (#2608) 3 months ago

README.md

👥 Join Our Community

Ⓜ️ About OpenIM

Unlike standalone chat applications such as Telegram, Signal, and Rocket.Chat, OpenIM offers an open-source instant messaging solution designed specifically for developers rather than as a directly installable standalone chat app. Comprising OpenIM SDK and OpenIM Server, it provides developers with a complete set of tools and services to integrate instant messaging functions into their applications, including message sending and receiving, user management, and group management. Overall, OpenIM aims to provide developers with the necessary tools and framework to implement efficient instant messaging solutions in their applications.

App-OpenIM Relationship

🚀 Introduction to OpenIMSDK

OpenIMSDK, designed for OpenIMServer, is an IM SDK created specifically for integration into client applications. It supports various functionalities and modules:

  • 🌟 Main Features:

    • 📦 Local Storage
    • 🔔 Listener Callbacks
    • 🛡️ API Wrapping
    • 🌐 Connection Management
  • 📚 Main Modules:

    1. 🚀 Initialization and Login
    2. 👤 User Management
    3. 👫 Friends Management
    4. 🤖 Group Functions
    5. 💬 Session Handling

Built with Golang and supports cross-platform deployment to ensure a consistent integration experience across all platforms.

👉 Explore the GO SDK

🌐 Introduction to OpenIMServer

  • OpenIMServer features include:
    • 🌐 Microservices Architecture: Supports cluster mode, including a gateway and multiple rpc services.
    • 🚀 Diverse Deployment Options: Supports source code, Kubernetes, or Docker deployment.
    • Massive User Support: Supports large-scale groups with hundreds of thousands, millions of users, and billions of messages.

Enhanced Business Functions:

  • REST API: Provides a REST API for business systems to enhance functionality, such as group creation and message pushing through backend interfaces.

  • Webhooks: Expands business forms through callbacks, sending requests to business servers before or after certain events.

    Overall Architecture

🚀 Quick Start

Experience online for iOS/Android/H5/PC/Web:

👉 OpenIM Online Demo

To facilitate user experience, we offer various deployment solutions. You can choose your preferred deployment method from the list below:

System Support

Supports Linux, Windows, Mac systems, and ARM and AMD CPU architectures.

✍️ How to Contribute

We welcome contributions of any kind! Please make sure to read our Contributor Documentation before submitting a Pull Request.

Thank you for contributing to building a powerful instant messaging solution!

📕 License

OpenIMSDK is available under the Apache License 2.0. See the LICENSE file for more information.

🔮 Thanks to our contributors!