Skip to content

jiangzhiguo1992/katydid_base_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

katydid_base_api

katydid_base_api 是一个基于 golangapi 项目,用于快速搭建api项目的环境,提供了一些基础的功能,功能如下:

  • 1.版本控制+统计系统
  • 2.用户认证+权限+统计系统
  • 3.账号认证+权限+统计系统
  • 4.公共消息(公告+客服)系统
  • 5.支付系统
  • 6.日志系统

所用到的框架如下:

  • 1.gin 用于搭建api
  • 2.gorm 用于操作数据库 (包括中间件 postgres、redis)
  • 3.viper 用于读取配置文件和分布式配置中心
  • 4.zap 用于日志记录 (内置fsnotify)
  • 5.testify 用于单元测试

运行项目可执行如下操作

1. 首先是构建镜像

1.构建单个镜像 Dockerfile (可以跳过,直接进行第2步)

dev:

    docker build -f deployments/docker/dev/client/Dockerfile -t  katydid_base_api-client_dev .

pro:

    docker build -f deployments/docker/prod/client/Dockerfile -t katydid_base_api-client_prod .
  • -f是指定的Dockerfile文件位置,-t是指定的镜像名称,其中 katydid_base_api-client 替换为自己的docker镜像名称,.是指上下文

2.构建组合镜像 docker-compose.yml

dev:

    docker-compose -f deployments/docker/dev/docker-compose.yml up --build -d

prod:

    docker-compose -f deployments/docker/pord/docker-compose.yml up --build -d
  • -f是指定的docker-compose.yml文件位置,--build强制构建(不使用缓存),-d后台运行

About

katydid base api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published