Hass/Message-Push-Nest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
EngiGu
2024-01-01 12:16:05 +08:00
committed by GitHub
parent 4a1e663396
commit ae6135331c
1 changed files with 8 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -86
View File
@@ -1,89 +1,11 @@
# Go Gin Example [![rcard](https://goreportcard.com/badge/github.com/EDDYCJY/go-gin-example)](https://goreportcard.com/report/github.com/EDDYCJY/go-gin-example) [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/EDDYCJY/go-gin-example) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/EDDYCJY/go-gin-example/master/LICENSE)
# Message Nest
An example of gin contains many useful features
如果你有很多消息推送方式，每次都需要调用各种接口去发送消息，这个项目可以帮你管理各种消息方式，并提供统一的api接入。你可以自由组合各种方式，一个api推送到各种渠道，帮你省去接入的繁琐步骤。
项目名叫信息巢，意思是一个拥有各种渠道信息方式的集合站点。
[简体中文](https://message-nest/blob/master/README_ZH.md)
# 效果图
![image](https://github.com/EngiGu/Message-Nest/assets/24751376/51bfae66-2671-418d-8af6-fdab53b3a763)
![image](https://github.com/EngiGu/Message-Nest/assets/24751376/f71a2e65-4fbb-4937-aaf7-7841a5b6b2a8)
![image](https://github.com/EngiGu/Message-Nest/assets/24751376/18558e0f-8fcd-40e9-aace-e642260fe229)
![image](https://github.com/EngiGu/Message-Nest/assets/24751376/aef58d51-7806-43a8-b98c-1f89cd075a38)
## Installation
```
$ go get github.com/EDDYCJY/go-gin-example
```
## How to run
### Required
- Mysql
- Redis
### Ready
Create a **blog database** and import [SQL](https://message-nest/blob/master/docs/sql/blog.sql)
### Conf
You should modify `conf/app.ini`
```
[database]
Type = mysql
User = root
Password =
Host = 127.0.0.1:3306
Name = blog
TablePrefix = blog_
[redis]
Host = 127.0.0.1:6379
Password =
MaxIdle = 30
MaxActive = 30
IdleTimeout = 200
...
```
### Run
```
$ cd $GOPATH/src/go-gin-example
$ go run main.go
```
Project information and existing API
```
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
- using env: export GIN_MODE=release
- using code: gin.SetMode(gin.ReleaseMode)
[GIN-debug] GET /auth --> message-nest/routers/api.GetAuth (3 handlers)
[GIN-debug] GET /swagger/*any --> message-nest/vendor/github.com/swaggo/gin-swagger.WrapHandler.func1 (3 handlers)
[GIN-debug] GET /api/v1/tags --> message-nest/routers/api/v1.GetTags (4 handlers)
[GIN-debug] POST /api/v1/tags --> message-nest/routers/api/v1.AddTag (4 handlers)
[GIN-debug] PUT /api/v1/tags/:id --> message-nest/routers/api/v1.EditTag (4 handlers)
[GIN-debug] DELETE /api/v1/tags/:id --> message-nest/routers/api/v1.DeleteTag (4 handlers)
[GIN-debug] GET /api/v1/articles --> message-nest/routers/api/v1.GetArticles (4 handlers)
[GIN-debug] GET /api/v1/articles/:id --> message-nest/routers/api/v1.GetArticle (4 handlers)
[GIN-debug] POST /api/v1/articles --> message-nest/routers/api/v1.AddArticle (4 handlers)
[GIN-debug] PUT /api/v1/articles/:id --> message-nest/routers/api/v1.EditArticle (4 handlers)
[GIN-debug] DELETE /api/v1/articles/:id --> message-nest/routers/api/v1.DeleteArticle (4 handlers)
Listening port is 8000
Actual pid is 4393
```
Swagger doc
![image](https://i.imgur.com/bVRLTP4.jpg)
## Features
- RESTful API
- Gorm
- Swagger
- logging
- Jwt-go
- Gin
- Graceful restart or stop (fvbock/endless)
- App configurable
- Cron
- Redis