Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tangtaoit committed Aug 1, 2023
1 parent 878675c commit 312a1bf
Showing 1 changed file with 142 additions and 17 deletions.
159 changes: 142 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,102 @@
</p>

<p align="center">
开源社区第二屌(🦅)的即时通讯软件
<!-- 开源社区第二屌(🦅)的即时通讯软件 -->
</p>

<p align="center">
一款非微信专家,非腾讯专家,历时<a href="#">八年</a>时间打造的<a href="#">运营级别</a>的开源即时通讯聊天软件(<a href='https://github.com/WuKongIM/WuKongIM'>悟空IM</a>提供通讯动力)
几个老工匠,历时<a href="#">八年</a>时间打造的<a href="#">运营级别</a>的开源即时通讯聊天软件(<a href='https://github.com/WuKongIM/WuKongIM'>开源WuKongIM</a>提供通讯动力)
</p>
<div align=center>

<!-- [![Go](https://github.com/TangSengDaoDao/TangSengDaoDaoUltimateServer/workflows/Go/badge.svg?branch=main)](https://github.com/TangSengDaoDao/TangSengDaoDaoUltimateServer/actions) -->
![GitHub go.mod Go version (subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/TangSengDaoDao/TangSengDaoDaoUltimateServer)
[![Go Report Card](https://goreportcard.com/badge/github.com/TangSengDaoDao/TangSengDaoDaoUltimateServer)](https://goreportcard.com/report/github.com/TangSengDaoDao/TangSengDaoDaoUltimateServer)
[![Release](https://img.shields.io/github/v/release/TangSengDaoDao/TangSengDaoDaoUltimateServer.svg?style=flat-square)](https://github.com/TangSengDaoDao/TangSengDaoDaoUltimateServer)
<!-- [![Go](https://github.com/TangSengDaoDao/TangSengDaoDaoServer/workflows/Go/badge.svg?branch=main)](https://github.com/TangSengDaoDao/TangSengDaoDaoServer/actions) -->
![GitHub go.mod Go version (subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/TangSengDaoDao/TangSengDaoDaoServer)
[![Go Report Card](https://goreportcard.com/badge/github.com/TangSengDaoDao/TangSengDaoDaoServer)](https://goreportcard.com/report/github.com/TangSengDaoDao/TangSengDaoDaoServer)
![License: Apache 2.0](https://img.shields.io/github/license/WuKongIM/WuKongIM)

<!-- [![Release](https://img.shields.io/github/v/release/TangSengDaoDao/TangSengDaoDaoServer.svg?style=flat-square)](https://github.com/TangSengDaoDao/TangSengDaoDaoServer) -->

</div>

`开发环境需要go >=1.20`

愿景
------------

让企业轻松拥有自己的即时通讯软件。

演示截图
架构图
------------

|对方正在输入|语音消息|合并转发|
|:---:|:---:|:--:|
|![](docs/screenshot/typing.webp)|![](docs/screenshot/voice.webp)|![](docs/screenshot/forward.webp)|
![架构图](./docs/architecture.png)

轻松上手
------------

|快速回复|群内操作| 其他功能 |
|:---:|:---:|:-------------------:|
|![](docs/screenshot/reply.webp)|![](docs/screenshot/group.webp)| ![](docs/screenshot/other.webp) |
安装脚本

![](docs/screenshot/pc2.png)
```shell

![](docs/screenshot/pc1.png)
curl -sSL https://gitee.com/TangSengDaoDao/TangSengDaoDaoCli/raw/main/install.sh | sudo bash

```

安装唐僧叨叨

```shell
tsdd install --ip xx.xx.xx.xx
```

`xx.xx.xx.xx为服务器IP地址(外网地址)`


开始唐僧叨叨

```shell
tsdd start
```

更多部署方式参考文档:https://tangsengdaodao.com/dev/backend/deploy-compose.html


相关源码
------------


### 唐僧叨叨(负责业务)

| 项目名 | Github地址 | Gitee地址 | 开源协议 | 说明 |
| ---- | ---------- | --------- | ---- | ---- |
| TangSengDaoDaoServer | [Github](https://github.com/TangSengDaoDao/TangSengDaoDaoServer) | [Gitee](https://gitee.com/TangSengDaoDao/TangSengDaoDaoServer) | Apache2.0 | 唐僧叨叨的业务端,负责一些业务逻辑,比如:好友关系,群组,朋友圈等 (通讯端使用的是 WuKongIM) |
| TangSengDaoDaoAndroid | [Github](https://github.com/TangSengDaoDao/TangSengDaoDaoAndroid) | [Gitee](https://gitee.com/TangSengDaoDao/TangSengDaoDaoAndroid) | Apache2.0 | 唐僧叨叨的Android端 |
| TangSengDaoDaoiOS | [Github](https://github.com/TangSengDaoDao/TangSengDaoDaoiOS) | [Gitee](https://gitee.com/TangSengDaoDao/TangSengDaoDaoiOS) | Apache2.0 | 唐僧叨叨的iOS端 |
| TangSengDaoDaoWeb | [Github](https://github.com/TangSengDaoDao/TangSengDaoDaoWeb) | [Gitee](https://gitee.com/TangSengDaoDao/TangSengDaoDaoWeb) | Apache2.0 | 唐僧叨叨的Web/PC端 |


### 悟空IM(负责通讯)

| 项目名 | Github地址 | Gitee地址 | 开源协议 | 说明 |
| ---- | ---------- | --------- | ---- | ---- |
| WuKongIM | [Github](https://github.com/WuKongIM/WuKongIM) | [Gitee](https://gitee.com/WuKongDev/WuKongIM) | Apache2.0 | 悟空IM通讯端,负责长连接维护,消息投递等等 |
| WuKongIMAndroidSDK | [Github](https://github.com/WuKongIM/WuKongIMAndroidSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMAndroidSDK) | Apache2.0 | 悟空IM的Android SDK |
| WuKongIMiOSSDK | [Github](https://github.com/WuKongIM/WuKongIMiOSSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMiOSSDK) | Apache2.0 | 悟空IM的iOS SDK |
| WuKongIMUniappSDK | [Github](https://github.com/WuKongIM/WuKongIMUniappSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMUniappSDK) | Apache2.0 | 悟空IM的 Uniapp SDK |
| WuKongIMJSSDK | [Github](https://github.com/WuKongIM/WuKongIMJSSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMJSSDK) | Apache2.0 | 悟空IM的 JS SDK |
| WuKongIMReactNativeDemo | [Github](https://github.com/wengqianshan/WuKongIMReactNative) || Apache2.0 | 悟空IM的 React Native Demo(由贡献者 [wengqianshan](https://github.com/wengqianshan) 提供) |
| WuKongIMFlutterSDK ||| Apache2.0 | 悟空IM的 Flutter SDK(开发中) |



技术文档
------------

唐僧叨叨:

https://tangsengdaodao.com

悟空IM:

https://githubim.com


功能特性
Expand All @@ -49,9 +110,13 @@
- [x] 消息加密传输
- [x] 消息多端同步(app,web,pc等)
- [x] 群聊人数无限制
- [x] 机器人
- [x] 消息列表
- [x] 单聊
- [x] 群聊
- [x] 发起群聊
- [x] 添加朋友
- [x] 扫一扫
- [x] 列表提醒项,比如消息@提醒,待办提醒,服务器可控
- [x] 置顶
- [x] 消息免打扰
Expand All @@ -69,13 +134,29 @@
- [x] Gif消息
- [x] 合并转发消息
- [x] 正在输入消息
- [x] 自定义消息
- [x] 撤回消息
- [x] 群系统消息
- [x] 群@消息
- [x] 消息回复
- [x] 消息转发
- [x] 消息收藏
- [x] 消息删除
- [x] 群功能
- [x] 添加群成员/移除群成员
- [x] 群成员列表
- [x] 群名称
- [x] 群二维码
- [x] 群公告
- [x] 保存到通讯录
- [x] 我在本群昵称
- [x] 群投诉
- [x] 清空群聊天记录
- [x] 好友
- [x] 备注
- [x] 拉黑
- [x] 投诉
- [x] 添加/解除好友
- [x] 通讯录
- [x] 新的朋友
- [x] 保存的群
Expand All @@ -90,7 +171,51 @@
- [x] 黑暗模式
- [x] 设备管理

更多特性,点击查看企业版。


动画演示
------------

||||
|:---:|:---:|:--:|
|![](./docs/screenshot/conversationlist.webp)|![](./docs/screenshot/messages.webp)|![](./docs/screenshot/robot.webp)|


||| |
|:---:|:---:|:-------------------:|
|![](./docs/screenshot/weblogin.webp)|![](./docs/screenshot/apm.webp)| ![](./docs/screenshot/others.webp) |

![](docs/screenshot/pc2.png)

![](docs/screenshot/pc1.png)


演示地址
------------
------------

| Android扫描体验 | iOS扫描体验(商店版本 apple store 搜“唐僧叨叨”) |
|:---:|:---:|
|![](docs/download/android.png)|![](docs/download/iOS.png)|

| Web端 | Windows端 | MAC端 | Ubuntun端 |
|:---:|:---:|:---:|:---:|
|[点击体验](https://web.botgate.cn)|[点击下载](https://github.com/TangSengDaoDao/TangSengDaoDaoWeb/releases/download/v1.0.0/tangsegndaodao_1.0.0_x64_zh-CN.msi)|[点击下载](https://github.com/TangSengDaoDao/TangSengDaoDaoWeb/releases/download/v1.0.0/tangsegndaodao_1.0.0_x64.dmg)|[点击下载](https://github.com/TangSengDaoDao/TangSengDaoDaoWeb/releases/download/v1.0.0/tangsegndaodao_1.0.0_amd64.deb)|


Star
------------

我们团队一直致力于即时通讯的研发,需要您的鼓励,如果您觉得本项目对您有帮助,欢迎点个star,您的支持是我们最大的动力。

加入群聊
------------

微信:加群请备注“唐僧叨叨”

<img src="docs/tsddwx.png" width="200px" height="200px">

许可证
------------

唐僧叨叨 使用 Apache 2.0 许可证。有关详情,请参阅 LICENSE 文件。

0 comments on commit 312a1bf

Please sign in to comment.