OpenIMSDK
/
openim-server
mirror of https://github.com/OpenIMSDK/Open-IM-Server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
openim-server/README.md

13 KiB
Raw Blame History

Ⓜ️ About OpenIM

OpenIM is a service platform specifically designed for integrating chat, audio-video calls, notifications, and AI chatbots into applications. It provides a range of powerful APIs and Webhooks, enabling developers to easily incorporate these interactive features into their applications. OpenIM is not a standalone chat application, but rather serves as a platform to support other applications in achieving rich communication functionalities. The following diagram illustrates the interaction between AppServer, AppClient, OpenIMServer, and OpenIMSDK to explain in detail.

App-OpenIM Relationship

🚀 About OpenIMSDK

OpenIMSDK is an IM SDK designed for OpenIMServer, created specifically for embedding in client applications. Its main features and modules are as follows:

  • 🌟 Main Features:

    • 📦 Local storage
    • 🔔 Listener callbacks
    • 🛡️ API wrapping
    • 🌐 Connection management

  • 📚 Main Modules:

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

It is built using Golang and supports cross-platform deployment, ensuring a consistent access experience across all platforms.

👉 Explore GO SDK

🌐 About OpenIMServer

  • OpenIMServer has the following characteristics:
    • 🌐 Microservice architecture: Supports cluster mode, including a gateway and multiple rpc services.
    • 🚀 Diverse deployment methods: Supports deployment via source code, Kubernetes, or Docker.
    • Support for massive user base: Super large groups with hundreds of thousands of users, tens of millions of users, and billions of messages.

Enhanced Business Functionality:

  • REST API: OpenIMServer offers REST APIs for business systems, aimed at empowering businesses with more functionalities, such as creating groups and sending push messages through backend interfaces.
  • Webhooks: OpenIMServer provides callback capabilities to extend more business forms. A callback means that OpenIMServer sends a request to the business server before or after a certain event, like callbacks before or after sending a message.

👉 Learn more

🏗️ Overall Architecture

Delve into the heart of Open-IM-Server's functionality with our architecture diagram.

Overall Architecture

🚀 Quick Start

We support many platforms. Here are the addresses for quick experience on the web side：

👉 OpenIM online web demo

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

🛠️ To Start Developing OpenIM

Open in Dev Container

OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the Community repository.

If you'd like to contribute to this Open-IM-Server repository, please read our contributor documentation.

Before you start, please make sure your changes are in demand. The best for that is to create a new discussion OR Slack Communication, or if you find an issue, report it first.

👥 Community

📆 Community Meetings

We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.

Our conference is in the OpenIM Slack 🎯, then you can search the Open-IM-Server pipeline to join

We take notes of each biweekly meeting in GitHub discussions, Our historical meeting notes, as well as replays of the meetings are available at Google Docs 📑.

👀 Who Are Using OpenIM

Check out our user case studies page for a list of the project users. Don't hesitate to leave a 📝comment and share your use case.

📄 License

OpenIM is licensed under the Apache 2.0 license. See LICENSE for the full license text.

The OpenIM logo, including its variations and animated versions, displayed in this repository OpenIM under the assets/logo and assets/logo-gif directories, are protected by copyright laws.

🔮 Thanks to our contributors!