github.com/binbinly/gin-chat @v0.0.1

友情提示

快速体验项目：在线访问地址。

项目api部署在Railway,每个月前500小时可正常访问

项目介绍

gin-chat 是一套仿微信ui的即时通讯全栈学习项目，项目UI出自 uni-app实战仿微信app开发

• 主要功能点如下
• 项目截图

📗 目录结构

• project-layout

后端技术

• http框架使用 Gin
• websocket使用 Websocket
• 数据库组件 GORM mysql连接
• redis组件 go-redis redis连接
• 命令行工具 Cobra
• 文档使用 Swagger 生成
• 配置文件解析库 Viper
• 使用 JWT 进行身份鉴权认证
• 校验器使用 validator 也是 Gin 框架默认的校验器
• 包管理工具 Go Modules
• 使用 GolangCI-lint 进行代码检测
• 使用 make 来管理 Go 工程

前端技术

代码入口

• 移动端 Vue 组件库 vant
• 脚手架 vue-cli4 vant rem 移动端框架方案
• 表情包 ChineseBQB

开发环境

项目部署

1,手动编译部署

TIPS: 需要本地安装 MySQL and Redis

# 下载安装
git clone https://github.com/binbinly/gin-chat

# 进入项目目录
cd gin-chat

# 编译
make build

# 修改 mysql redis 配置
cd build/configs

# 运行
make run

2.Docker部署

docker安装文档

cd gin-chat
# 1. build image: 
docker build -t chat:latest -f Dockerfile .
# 2. start: 
docker run --rm -it -p 9050:9050 -p 9060:9060 chat:latest server
# 启动时设置 --rm 选项，这样在容器退出时就能够自动清理容器内部的文件系统

3. Railway部署 (✅推荐)

Railway每月提供5美元和最多500小时的免费额度。 1. 2. 设置环境变量来重载程序运行的参数，set env PORT => 9050 前端打包后的代码部署在 github-page

常用命令

• make help 查看帮助
• make init 初始化数据结构，并填充数据库表情包数据
• make build 编译项目
• make run 运行项目
• make test 运行测试用例
• make clean 清除编译文件
• make doc 生成接口文档
• make lint 代码检查
• make graph 生成交互式的可视化Go程序调用图
• make docker 生成docker镜像，确保已安装docker

📝 接口文档

TIPS: 只有本地环境开启了文档 - chat接口文档

AI辅助

• openai
• codeium
• opencommit
• chatgpt-next

其他

• 编码规范: Uber Go 语言编码规范