Gin-Admin 开源项目安装与配置指南

Gin-Admin 开源项目安装与配置指南

gin-admin A lightweight, flexible, elegant and full-featured RBAC scaffolding based on GIN + GORM 2.0 + Casbin 2.0 + Wire DI.基于 Golang + Gin + GORM 2.0 + Casbin 2.0 + Wire DI 的轻量级、灵活、优雅且功能齐全的 RBAC 脚手架。 项目地址: https://gitcode.com/gh_mirrors/gi/gin-admin

1. 项目基础介绍

Gin-Admin 是一个基于 Golang 语言的开源项目，它提供了一个轻量级、灵活、优雅且功能齐全的 RBAC（基于角色的访问控制）脚手架。该项目利用了现代的编程技术和框架，旨在帮助开发者快速构建企业级的应用程序。

2. 项目使用的关键技术和框架

• Golang：项目的主体编程语言。
• Gin：一个高性能的 Web 框架，用于处理 HTTP 请求。
• GORM 2.0：一个功能强大的 ORM（对象关系映射）框架，用于数据库操作。
• Casbin：一个支持多种访问控制模型的权限框架，用于实现 RBAC。
• Wire：一个依赖注入工具，用于简化模块间的依赖关系。
• JWT：JSON Web Token，用于用户身份验证。
• Swagger：自动生成 API 接口文档的工具。

3. 项目安装和配置的准备工作

在开始安装和配置 Gin-Admin 前，确保您的开发环境满足以下要求：

• Go：安装 Go 语言环境，版本需在 1.19 或以上。
• Git：安装 Git，用于克隆和下载项目代码。
• Docker（可选）：如果需要使用 Docker，请确保已安装 Docker。

详细的安装步骤

步骤 1：克隆项目

打开终端或命令提示符，执行以下命令克隆项目：

git clone https://github.com/LyricTian/gin-admin.git

步骤 2：安装依赖

进入项目目录，安装项目所需的依赖：

cd gin-admin
go mod tidy

步骤 3：安装 Wire

Wire 是一个代码生成工具，用于处理依赖注入。安装 Wire：

go install github.com/google/wire/cmd/wire@latest

步骤 4：安装 Swagger（可选）

如果需要生成 API 文档，安装 Swagger：

go install github.com/swaggo/swag/cmd/swag@latest

步骤 5：配置项目

根据需要修改项目配置文件，如 configs/dev/server.toml，设置服务器相关的配置。

步骤 6：启动服务

使用 Makefile 提供的命令启动服务：

make start

或者直接运行主程序：

go run main.go start

步骤 7：构建 Docker 镜像（可选）

如果需要创建 Docker 镜像，执行以下命令：

docker build -f ./Dockerfile -t gin-admin:v1.0.0 .

步骤 8：生成 Swagger 文档（可选）

执行以下命令生成 Swagger 文档：

make swagger

或者：

swag init --parseDependency --generalInfo ./main.go --output ./internal/swagger

完成以上步骤后，您应该能够成功安装和配置 Gin-Admin 项目，并开始开发您自己的应用程序了。

gin-admin A lightweight, flexible, elegant and full-featured RBAC scaffolding based on GIN + GORM 2.0 + Casbin 2.0 + Wire DI.基于 Golang + Gin + GORM 2.0 + Casbin 2.0 + Wire DI 的轻量级、灵活、优雅且功能齐全的 RBAC 脚手架。 项目地址: https://gitcode.com/gh_mirrors/gi/gin-admin