coverupforV / to-do-list

Todo List 备忘录

此项目使用Gin+Gorm ，基于RESTful API实现的一个备忘录。

前端仓库地址：https://github.com/CocaineCong/react-todolist

项目运行

手动执行

本项目使用Go Mod管理依赖。

将所有环境拉取启动

make env-up

下载依赖

go mod tidy

运行

go run ./cmd/main.go

将所有环境关闭并删除

make env-down

接口文档

Todo List 接口文档

密码：0000

也可以启动项目后，直接访问 http://localhost:3000/swagger/index.html

查看swagger文档

项目主要功能介绍

• 用户注册登录 ( jwt-go鉴权 )
• 新增/删除/修改/查询 备忘录
• 存储每条备忘录的浏览次数
• 分页功能

项目主要依赖：

Golang V1.15

• Gin
• Gorm
• mysql
• redis
• ini
• jwt-go
• logrus
• go-swagger

项目结构

TodoList/
├── api
├── cmd
├── conf
├── consts
├── docs
├── middleware
├── pkg
│  ├── e
│  └── util
├── routes
├── repository
│  ├── cache
│  └── db
│     ├── dao
│     └── model
├── routes
├── service
└── types

• api : 用于定义接口函数,也就是controller层
• cmd : 程序启动
• conf : 用于存储配置文件
• middleware : 应用中间件
• pkg/e : 封装错误码
• pkg/logging : 日志打印
• pkg/util : 工具函数
• repository: 仓库放置所有存储
• repository/cache: 放置redis缓存
• repository/db: 持久层MySQL仓库
• repository/db/dao: 对db进行操作的dao层
• repository/db/model: 定义所有持久层数据库表结构的model层
• routes : 路由逻辑处理
• service : 接口函数的实现
• types : 放置所有的定义的结构体