90 lines
1.9 KiB
Markdown
90 lines
1.9 KiB
Markdown
# openim-chat
|
||
|
||
|
||
|
||
## 🧩 功能简介
|
||
|
||
1. 该仓库实现了业务系统，包括两部分：用户系统和后台管理系统。
|
||
2. 该系统依赖于 [chat-deploy 仓库](https://github.com/openimsdk/chat-deploy)，通过调用即时消息系统的 API 实现丰富的业务功能。
|
||
3. 用户系统包括一些常规功能，如用户登录、用户注册、用户信息更新等。
|
||
4. 后台管理系统包括提供了 API 管理用户、群组和消息等。
|
||
|
||
## :busts_in_silhouette: 社区
|
||
|
||
- 💬 [关注我们的 Twitter 账户](https://twitter.com/founder_im63606)
|
||
- 🚀 [加入我们的 Slack 社区](https://join.slack.com/t/openimsdk/shared_invite/zt-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A)
|
||
- :eyes: [加入我们的微信群](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
|
||
|
||
## 🛫 快速开始
|
||
|
||
> :warning: **注意**：本项目在 Linux/Windows/Mac 平台以及 ARM 和 AMD 架构下均可正常使用
|
||
|
||
### 📦 克隆
|
||
|
||
```bash
|
||
git clone https://git.imall.cloud/openim/chat openim-chat
|
||
cd openim-chat
|
||
```
|
||
|
||
### 🛠 初始化
|
||
|
||
:computer: 第一次编译前，Linux/Mac 平台下执行：
|
||
|
||
```
|
||
sh bootstrap.sh
|
||
```
|
||
|
||
:computer: Windows 执行：
|
||
|
||
```
|
||
bootstrap.bat
|
||
```
|
||
|
||
### 🏗 编译
|
||
|
||
```bash
|
||
mage
|
||
```
|
||
|
||
### 🚀 启动
|
||
|
||
```bash
|
||
mage start
|
||
```
|
||
|
||
### :floppy_disk: 或后台启动 收集日志
|
||
|
||
```
|
||
nohup mage start >> _output/logs/chat.log 2>&1 &
|
||
```
|
||
|
||
### :mag_right: 检测
|
||
|
||
```bash
|
||
mage check
|
||
```
|
||
|
||
### 🛑 停止
|
||
|
||
```bash
|
||
mage stop
|
||
```
|
||
|
||
### 🚀 启动顺序
|
||
|
||
1. 成功启动 [chat-deploy](https://github.com/openimsdk/chat-deploy)。
|
||
2. 编译 chat `mage`。
|
||
3. 启动 chat `mage start`。
|
||
|
||
## 📞 如果您想启用音视频通话，请配置 LiveKit
|
||
|
||
:link: 请参考 "[如何设置 LiveKit 服务器](./HOW_TO_SETUP_LIVEKIT_SERVER.md)"。
|
||
|
||
## :handshake: 贡献
|
||
|
||
:heart: 欢迎对该项目做出贡献！请查看 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解详情。
|
||
|
||
## 🚨 许可
|
||
|
||
This software is licensed under the Apache License 2.0
|