Gin-Vue-Admin 项目教程
1. 项目的目录结构及介绍
Gin-Vue-Admin 是一个基于 Gin 和 Vue 的全栈前后端分离的开发基础平台。以下是项目的目录结构及其介绍:
gin-vue-admin/
├── api # 接口文件
├── assets # 静态资源
├── cmd # 启动文件
├── config # 配置文件
├── docs # 文档
├── initialize # 初始化文件
├── middleware # 中间件
├── model # 数据模型
├── packfile # 打包文件
├── router # 路由
├── service # 服务层
├── storage # 存储文件
├── script # 脚本文件
├── static # 静态文件
├── template # 模板文件
├── test # 测试文件
├── utils # 工具类
├── web # 前端文件
├── .env # 环境变量配置
├── .gitignore # Git忽略文件
├── go.mod # Go模块文件
├── go.sum # Go模块校验文件
├── LICENSE # 许可证
├── README.md # 项目说明
1.1 api 目录
存放后端接口文件,每个文件对应一个模块的接口。
1.2 assets 目录
存放项目所需的静态资源文件。
1.3 cmd 目录
存放项目的启动文件。
1.4 config 目录
存放项目的配置文件,包括数据库配置、日志配置等。
1.5 docs 目录
存放项目的文档文件。
1.6 initialize 目录
存放项目的初始化文件,包括数据库初始化、路由初始化等。
1.7 middleware 目录
存放项目的中间件文件,用于处理请求和响应。
1.8 model 目录
存放项目的数据模型文件,定义数据结构和数据库表结构。
1.9 packfile 目录
存放项目的打包文件。
1.10 router 目录
存放项目的路由文件,定义URL和处理函数的映射关系。
1.11 service 目录
存放项目的服务层文件,处理业务逻辑。
1.12 storage 目录
存放项目的存储文件,如上传的文件等。
1.13 script 目录
存放项目的脚本文件,如数据库迁移脚本等。
1.14 static 目录
存放项目的静态文件,如图片、CSS、JS等。
1.15 template 目录
存放项目的模板文件,如HTML模板等。
1.16 test 目录
存放项目的测试文件,用于单元测试和集成测试。
1.17 utils 目录
存放项目的工具类文件,提供各种实用函数。
1.18 web 目录
存放项目的前端文件,包括Vue组件、路由等。
1.19 .env 文件
存放项目的环境变量配置。
1.20 .gitignore 文件
定义Git忽略的文件和目录。
1.21 go.mod 文件
定义Go模块的依赖关系。
1.22 go.sum 文件
定义Go模块的校验文件。
1.23 LICENSE 文件
定义项目的许可证。
1.24 README.md 文件
项目的说明文档。
2. 项目的启动文件介绍
项目的启动文件位于 cmd
目录下,主要负责启动整个应用程序。以下是启动文件的介绍:
cmd/
├── main.go # 主启动文件
2.1 main.go 文件
main.go
是项目的入口文件,负责初始化配置、加载路由、启动服务器等。
package main
import (
"gin-vue-admin/initialize"
)
func main() {
// 初始化配置
initialize.InitConfig()
// 初始化路由
initialize.InitRouter()
// 启动服务器
initialize.RunServer()
}
3. 项目的配置文件介绍
项目的配置文件位于 config
目录下,主要负责配置数据库、日志、JWT等。以下是配置文件的介绍:
config/