Files
Message-Push-Nest/README.md
T

85 lines
3.5 KiB
Markdown
Raw Normal View History

2024-01-02 21:23:28 +08:00
# Message Nest 🕊️
2023-12-30 17:40:20 +08:00
2024-01-02 15:22:03 +08:00
Message Nest 是一个灵活而强大的消息推送整合平台,旨在简化并自定义多种消息通知方式。
2024-01-01 12:16:05 +08:00
项目名叫信息巢,意思是一个拥有各种渠道信息方式的集合站点。
2023-12-30 17:40:20 +08:00
2024-01-22 19:33:53 +08:00
如果你有很多消息推送方式,每次都需要调用各种接口去发送消息到各个渠道,或者不同的项目你都需要复制同样的发消息代码,这个项目可以帮你管理各种消息方式,并提供统一的发送api接入。你可以自由组合各种消息渠道,一个api推送到各种渠道,帮你省去接入的繁琐步骤。
2024-01-02 15:22:03 +08:00
## 特色 ✨
- 🔄 **整合性:** 提供了多种消息推送方式,包括邮件、钉钉、企业微信等,方便你集中管理和定制通知。
- 🎨 **自定义性:** 可以根据需求定制消息推送策略,满足不同场景的个性化需求。
- 🛠 **开放性:** 易于扩展和集成新的消息通知服务,以适应未来的变化。
2024-01-02 15:31:05 +08:00
## 进度 🔨
2024-01-01 13:20:06 +08:00
项目还在不断更新中,欢迎大家提出各种建议。
2024-01-09 14:03:39 +08:00
关于日志,考虑到目前多数服务以收集控制台输出为主,暂时不支持写出日志文件。
2024-01-20 16:43:55 +08:00
2024.01.20
- [x] 添加日志查看自动刷新
----
2024-01-17 23:15:47 +08:00
2024.01.07
- [x] 支持站点信息自定义
----
2024.01.03
- [x] 支持企业微信
----
2024-01-22 19:36:44 +08:00
- [x] 单应用打包,直接运行,不用部署前端页面
2024-01-02 20:22:03 +08:00
- [x] 支持邮件发送
- [x] 用户密码设置
- [x] 支持用户定时任务清理,更新定时时间
- [x] 查看定时清理日志
- [x] 单应用的html浏览器自动缓存
- [x] gin的日志使用logrus
2024-01-03 20:27:29 +08:00
- [x] 支持异步发送
2024-01-01 13:44:27 +08:00
- [x] 支持邮件发送
2024-01-06 17:45:58 +08:00
- [x] 支持钉钉
2024-01-07 00:30:32 +08:00
- [x] 支持自定义的webhook消息发送
2024-01-14 20:55:38 +08:00
- [x] 企业微信
2024-01-01 13:44:27 +08:00
- [ ] ....
2024-01-02 15:31:05 +08:00
## 项目来由 💡
2024-01-01 13:18:26 +08:00
自己常常写一些脚本需要消息推送,经常需要接入不同的消息发送,很不方便,于是就有了这个项目。
2024-01-02 15:34:44 +08:00
## 效果图 📺
2024-01-20 17:11:06 +08:00
![image](https://raw.githubusercontent.com/engigu/resources/images/2024/01/20/3161bbbed2fd191f837456254b233434.gif)
2024-01-02 15:22:03 +08:00
## 使用方法 🚀
2024-01-02 19:54:48 +08:00
1. 下载最新的系统版本对应的release, 解压
2024-01-07 22:06:15 +08:00
2. 新建一个数据库
3. 重命名conf/app.example.ini为conf/app.ini
4. 修改app.ini对应的配置
2024-01-13 13:50:35 +08:00
5. 启动项目会自动创建表和账号
2024-01-13 13:43:30 +08:00
```shell
# 第一次运行将app.ini中的app.InitData设置为enable,会自动进行表数据的初始化
# 后续不需要开启这个配置
# INFO登录启动回出现如下日志
[2024-01-13 13:40:09.075] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_auth
[2024-01-13 13:40:11.778] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks
[2024-01-13 13:40:16.518] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_ways
[2024-01-13 13:40:23.300] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks_logs
[2024-01-13 13:40:28.715] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_send_tasks_ins
[2024-01-13 13:40:39.538] INFO [migrate.go:70 Setup] [Init Data]: Migrate table: message_settings
[2024-01-13 13:40:46.299] INFO [migrate.go:74 Setup] [Init Data]: Init Account data...
[2024-01-13 13:40:46.751] INFO [migrate.go:77 Setup] [Init Data]: All table data init done.
```
2024-01-02 20:00:52 +08:00
6. 启动项目,访问8000端口,初始账号为admin,密码为123456
2024-01-02 19:54:48 +08:00
2024-01-02 15:28:09 +08:00
## 贡献 🤝
2024-01-02 19:59:19 +08:00
欢迎通过提交问题和提出改进建议。
2024-01-02 15:28:09 +08:00
## 致谢 🙏
该项目汲取了[go-gin-example](https://github.com/eddycjy/go-gin-example)项目的灵感,展示了 Go 和 Gin 在实际应用中的强大和多才多艺。
## 许可证 📝
[LICENSE](LICENSE)