# Deliver

**Repository Path**: hello-rong/deliver

## Basic Information

- **Project Name**: Deliver
- **Description**: Deliver 消息推送平台是业界首个基于 SpringBoot3、面向企业的全面消息推送平台，旨在提供企业内部沟通和协作的便捷解决方案。它以轻量级部署、简单易用、支持多种通信渠道为特点，为企业提供高效的消息传递和通知功能。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://oszero.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 138
- **Created**: 2024-06-01
- **Last Updated**: 2024-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<img alt="logo" src="image/logo.png" width="168" height="150">

<h1 style="margin: 30px 0 30px; font-weight: bold;">Deliver</h1>

<h4 align="center">一个轻量级企业消息推送平台，旨在提供企业内部沟通和协作的便捷解决方案！</h4>

<a href="https://os-zero.gitee.io/deliver-website/" target="_blank">官方网站</a> |
<a href="https://gitee.com/OS-Zero/deliver/issues" target="_blank">需求收集</a> |
<a href="https://gitee.com/OS-Zero/deliver/issues" target="_blank">问题反馈</a>

<a href='https://gitee.com/OS-Zero/deliver/stargazers'><img src='https://gitee.com/OS-Zero/deliver/badge/star.svg?theme=dark' alt='star'></img></a>
<a href='https://gitee.com/OS-Zero/deliver/members'><img src='https://gitee.com/OS-Zero/deliver/badge/fork.svg?theme=dark' alt='fork'></img></a>
</div>

--------------------------

## 项目介绍

**Deliver**
消息推送平台，企业内部的消息推送系统，旨在提供企业内部沟通和协作的便捷解决方案。它以轻量级部署、简单易用、支持多种通信渠道为特点，为企业提供高效的消息传递和通知功能。我们相信高效的内部沟通对企业的成功至关重要，Deliver
将成为您实现这一目标的得力助手。无论您需要电话通知、短信提醒、邮件通告，还是钉钉、企业微信和飞书的消息推送，Deliver 都能满足您的需求。

## 系统架构
![](image/architecture_diagram.png)

## 消息发送时序图
<img alt="消息时序图-生产者" src="image/消息时序图-生产者.png">
<img alt="消息时序图-消费者" src="image/消息时序图-消费者.png">

## 核心特性

- 支持阿里云、腾讯云、华为云电话服务。
- 支持阿里云、腾讯云、华为云短信服务。
- 支持邮件消息推送功能。
- 支持钉钉文本、图片、语音、文件、链接、OA、markdown、卡片、机器人等消息类型推送。
- 支持企业微信文本、图片、语音、视频、文件、文本卡片、图文、markdown 等消息类型推送。
- 支持飞书文本、富文本、图片、消息卡片、分享群名片、语音、视频、文件等消息类型推送。
- 支持钉钉、企业微信、飞书，消息文件上传功能，统一进行文件管理，便于发送多媒体消息。
- 消息日志均包含 TraceId，便于日志采集分析，消息链路追踪。
- 支持消息数据可视化，查看消息详情等功能。
- 轻量级部署，仅依赖 MySQL、MQ、Redis（最轻量级只需依赖 MySQL、Redis）。
- 支持多种 MQ，包括 RabbitMQ、RocketMQ、Kafka 等，后续支持 Apache Pulsar 等。
- 支持各语言 SDK，轻松接入系统（Java、Go、Python、Cpp 等）。
- 管理端前端支持 Vue3、React 两种版本可供选择，UI 设计采用 Ant Design Pro，界面美观简洁。
- 支持 Jar 包 Shell、Docker 镜像等多种部署方式。

## 最佳实践

- Deliver 消息推送平台，推崇轻量级部署方式，消息链路追踪已实现日志打印输出到具体文件功能，可根据自身情况搭建日志采集分析服务。
- 消息推送服务端并没有设置鉴权功能，推荐采用 API 网关（Apache ShenYu、阿里云网关等）进行鉴权拦截。
- 考虑到企业内部统一认证系统的不同，所以消息推送管理端并没有设置用户登录认证鉴权功能，可自行根据实际情况引入。
- 高可用、高性能部署方案，采用服务端集群（缓存为分布式 Redis 缓存）、MQ 集群、网关负载均衡等策略。

## 后台管理描述

| 一级菜单 | 二级菜单      | 功能描述                       |
|:-----|:---------|:---------------------------|
|欢迎页|欢迎|Deliver 相关介绍|
|系统监控看板|平台数据看板|平台内部的数据可视化展示|
|消息模板配置|消息模板|消息推送模板的 CRUD|
|渠道APP配置|APP 配置|各渠道 APP 相关配置 CRUD|
|平台文件管理|文件管理|钉钉、企微、飞书多媒体文件管理|

## 在线演示

- 管理端：敬请期待

## 项目部分截图
### 首页
--- 
<img alt="首页.jpeg" src="image/首页.jpeg">

### 数据看板
---
<img alt="数据看板" src="image/数据看板.png">

### 消息模版
---
<img alt="消息模版" src="image/消息模版.png">
<img alt="消息模版-测试" src="image/消息模版-测试.png">

### APP 配置
---
<img alt="APP配置" src="image/APP配置.png">

### 文件管理
---
<img alt="文件管理-更多" src="image/文件管理-更多.png">
<img alt="文件管理-上传平台文件" src="image/文件管理-上传平台文件.png">

## 技术栈

- 后端：Spring Boot、Mybatis-Plus、Spring Cache
- 前端：Vue.js、React.js、Ant Design Pro
- 依赖软件：MySQL、Redis、MQ、Docker

## 交流群

<a href="https://os-zero.gitee.io/deliver-website/pages/3a3a11/" target="_blank">点击加入群聊</a>

## 参与贡献

我们强烈欢迎有兴趣的开发者参与到项目建设中来，同时欢迎大家对项目提出宝贵建议和功能需求，项目正在积极开发，欢迎 PR 👏。
推荐阅读：<a href="https://os-zero.gitee.io/deliver-website/pages/2a2a11/#%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97" target="_blank">贡献指南</a>

## 接入登记

如果您和您的公司或组织使用了 Deliver，非常感谢您的支持与信任，请 [在此](https://gitee.com/OS-Zero/deliver/issues/I8IPY3) 进行接入登记，您的回复将成为维护者、社区用户和观望者的信心来源。感谢支持 💖
> 登记信息仅用于推广本产品～