README-zh.md

Gohub

基于 Gin 框架的 Go 语言论坛 API 项目

使用到的开源库

• gin 路由、路由组、中间件

• zap 高性能日志方案

• gorm ORM 数据操作

• cobra 命令行结构

• viper 配置信息

• cast 类型转换

• redis Redis 操作

• jwt JWT 操作

• base64Captcha 图片验证码

• govalidator 请求验证器

• limiter 限流器

• email SMTP 邮件发送

• aliyun-communicate 发送阿里云短信

• ansi 终端高亮输出

• strcase 字符串大小写操作

• pluralize 英文字符单数复数处理

• faker 假数据填充

• imaging 图片裁切

自定义包

• app 应用对象
• auth 用户授权
• cache 缓存
• captcha 图片验证码
• config 配置信息
• console 终端
• database 数据库操作
• file 文件处理
• hash 哈希
• helpers 辅助方法
• jwt JWT 认证
• limiter API 限流
• logger 日志处理
• mail 邮件发送
• migrate 数据库迁移
• paginator 分页器
• redis Redis 数据库操作
• response 响应处理
• seed 假数据填充
• sms 发送短信
• str 字符串处理
• verifycode 数字验证码

支持的指令

$ go run main.go -h
Default will run "serve" command, you can use "-h" flag to see all subcommands

Usage:
  Gohub [command]

Available Commands:
  cache       Cache management
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  key         Generate App Key, will print the generated key
  make        Generate file nad code
  migrate     Run database migration
  play        Likes the Go Playground, but running at our application context
  seed        Insert fake data to the database
  serve       Start web server

Flags:
  -e, --env string   load .env file, example: --env=testing will use .env.testing file
  -h, --help         help for Gohub

Use "Gohub [command] --help" for more information about a command.

TODO

Postman 文档书写 支持多种缓存中间件，目前只支持 Redis 使用多种 Web 框架重构，例如 Iris，Fiber 等