Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 2.85 KB

README.md

File metadata and controls

101 lines (64 loc) · 2.85 KB
Raw

openim-chat

📄 License Options for OpenIM Source Code

You may use the OpenIM source code to create compiled versions not originally produced by OpenIM under one of the following two licensing options:

1. GNU General Public License v3.0 (GPLv3) 🆓

  • This option is governed by the Free Software Foundation's GPL v3.0.
  • Usage is subject to certain exceptions as outlined in this policy.

2. Commercial License 💼

  • Obtain a commercial license by contacting OpenIM.
  • For more details and licensing inquiries, please email 📧 [email protected].

🧩 Feature Overview

  1. This repository implements a business system, which consists of two parts: User System and Backend Management System.
  2. The system relies on the open-im-server repository and implements various business functions by calling the APIs of the instant messaging system.
  3. The User System includes regular functions such as user login, user registration, user information update, etc.
  4. The Backend Management System includes APIs for managing users, groups, and messages.

👥 Community

🛫 Quick Start

⚠️ Note: This project works on Linux/Windows/Mac platforms and both ARM and AMD architectures.

📦 Clone

git clone https://github.com/openimsdk/chat openim-chat
cd openim-chat

🛠 Initialization

💻 Before the first compilation, execute on Linux/Mac platforms:

sh bootstrap.sh

💻 On Windows execute:

bootstrap.bat

🏗 Build

mage

🚀 Start

mage start

💾 Or start in the background and collect logs

nohup mage start >> _output/logs/chat.log 2>&1 &

🔎 Check

mage check

🛑 Stop

mage stop

🚀 Start Sequence

  1. Successfully start open-im-server.
  2. Compile chat mage.
  3. Start chat mage start.

📞 If you want to enable audio and video calls, please configure LiveKit

🔗 Please refer to "How to set up LiveKit server".

🤝 Contributing

❤️ Contributions to this project are welcome! Please see CONTRIBUTING.md for details.

🚨 License

📜 chat is licensed under the GPL-3.0 license. See the LICENSE for the full license text.