# GeeseLink

**Repository Path**: tiejia-xiaobao/GeeseLink

## Basic Information

- **Project Name**: GeeseLink
- **Description**: GeeseLink is a lightweight message middleware based on sms4j.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2024-05-28
- **Last Updated**: 2024-06-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="todo">
     <img alt="geeselink" src="./doc/images/logo.png" width="240">
  </a>
</p>

<h4 align="center">
<a href="README_CN.md">English Document</a> | <a href="README_CN.md">中文文档</a>
</h4>

<p align="center">
    <a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0.txt">
		<img src="https://img.shields.io/:license-Apache2-blue.svg" alt="Apache 2" />
	</a>
    <a target="_blank" href="https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html">
		<img src="https://img.shields.io/badge/JDK-8-green.svg" alt="jdk-8" />
	</a>
        <img src="https://img.shields.io/badge/SpringBoot-v2.x-blue">
    <a target="_blank" href='https://gitee.com/tiejia-xiaobao/geese-link'>
		<img src='https://gitee.com/tiejia-xiaobao/geese-link/badge/star.svg' alt='Gitee star'/>
	</a>
    <a target="_blank" href='https://github.com/TJxiaobao/GeeseLink'>
		<img src="https://img.shields.io/github/stars/TJxiaobao/GeeseLink.svg?logo=github" alt="Github star"/>
	</a>
</p>

## 🎡 <font color="green">介绍</font>
GeeseLink 是一款基于sms4j的轻量级消息中台。

### 特点
- 具有同步和异步发送短信的功能。
- 具有Sms4j集成所有短信厂商的短信业务。
- 邮件发送。
- OA发送（开发中）。
- 可配置消息发送优先级、重试次数、超时时间等。
- 消息模板管理。
- 消息发送监控。
- 具有分布式集群消费信息（开发中）。
- 消息告警（开发中）。
- 消息推送（开发中）。
- 消息日志（开发中）。
- 消息黑名单（已完成）。
- ...

## 🥐 模块

### 🍔 [geeselink-common](./geeselink-common)
- 公共模块
- 通用工具类
- 公共配置
- 公共异常
- ...

### 🍟 [geeselink-job](./geeselink-job)
- 任务调度模块
- 定时任务
- 异步任务
- ...

### 🍕 [geeselink-srv](./geeselink-srv)
- 服务模块
- 短信服务
- 邮件服务
- 模版服务
- ...

### 🍦 [geeselink-monitor](./geeselink-monitor)
- 监控模块
- 消息发送监控
- ...

### 🍨 [geeselink-ui](./geeselink-ui)
- 前端模块
- ...

## 🍹 架构图
![geeselink](./doc/images/system_architecture.png)

## 🐕 快速开始

- todo

### 🐈 1、本地安装
todo

### 🐈 2、Docker安装
todo


## ✨ Contributors

<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/TJxiaobao"><img src="https://avatars.githubusercontent.com/u/85919258?v=4?s=100" width="100px;" alt="铁甲小宝"/><br /><sub><b>铁甲小宝</b></sub></a><br /><a href="https://github.com/GeeseLink/issues?q=author%TJxiaobao" title="Design">🎨</a> <a href="https://github.com/GeeseLink/commits?author=TJxiaobao" title="Code">💻</a> <a href="https://github.com/GeeseLink/commits?author=TJxiaobao" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ZY945"><img src="https://avatars.githubusercontent.com/u/74083801?v=4?s=100" width="100px;" alt="东风"/><br /><sub><b>东风</b></sub></a><br /><a href="https://github.com/GeeseLink/commits?author=ZY945" title="Code">💻</a> <a href="#design-ZY945" title="Design">🎨</a> <a href="https://github.com/GeeseLink/commits?author=ZY945" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/forcejie"><img src="https://avatars.githubusercontent.com/u/106960734?v=4?s=100" width="100px;" alt="东非不开森"/><br /><sub><b>东非不开森</b></sub></a><br /><a href="https://github.com/GeeseLink/issues?q=author%forcejie" title="Design">🎨</a> <a href="https://github.com/GeeseLink/commits?author=forcejie" title="Code">💻</a> <a href="https://github.com/GeeseLink/commits?author=forcejie" title="Documentation">📖</a></td>
    </tr>
    </tbody>
</table>


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=TJxiaobao/GeeseLink&type=Date)](https://star-history.com/#TJxiaobao/GeeseLink&Date)


## 🍔 有话说
本项目目前处于开发阶段，可能有很多地方并不是很完善，希望大家多多包含。也希望大家能够多多支持！
开源不易，希望大家多多支持，谢谢！
- 如果你觉得这个项目不错，欢迎给我一个star。
- 如果你有更好的建议，欢迎提出issue。
- 如果你想参与这个项目，欢迎提交pr。