# GinAdmin

**Repository Path**: dhl-plum/gin-admin

## Basic Information

- **Project Name**: GinAdmin
- **Description**: GinAdmin是一个基于Gin框架和Vue3的管理系统，提供用户管理、权限控制、消息通知等核心功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-03-24
- **Last Updated**: 2025-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GinAdmin

GinAdmin是一个基于Gin框架和Vue3的管理系统，提供用户管理、权限控制、消息通知等核心功能。

## 项目介绍

GinAdmin采用前后端分离架构，后端使用Go语言的Gin框架，前端使用Vue3 + Element Plus，支持多种数据库。

### 主要功能

- 用户与组织管理：用户、角色、部门管理
- 权限控制：基于Casbin的RBAC权限控制
- 消息与通知：站内消息、通知
- 系统设置：全局配置管理

## 项目结构

项目分为服务端和Web前端两部分：

### 后端目录结构

```
server/
├── api/            # API控制器
├── configs/        # 配置文件
├── core/           # 核心功能包
│   ├── auth/       # 认证与权限
│   ├── config/     # 配置管理
│   ├── database/   # 数据库操作
│   ├── jwt/        # JWT工具
│   ├── logger/     # 日志工具
│   └── middleware/ # 中间件
├── migration/      # 数据库迁移
├── model/          # 数据模型
├── router/         # 路由定义
├── scripts/        # 脚本文件
├── service/        # 业务服务
├── main.go         # 入口文件
└── go.mod          # Go模块定义
```

### 前端目录结构

```
web/
├── public/            # 静态资源
├── src/               # 源代码
│   ├── api/           # API接口封装
│   ├── assets/        # 资源文件（图片等）
│   ├── components/    # 公共组件
│   ├── layout/        # 布局组件
│   ├── router/        # 路由配置
│   ├── stores/        # 状态管理
│   ├── styles/        # 全局样式
│   ├── utils/         # 工具类
│   ├── views/         # 页面组件
│   ├── App.vue        # 根组件
│   └── main.js        # 入口文件
├── .env.development   # 开发环境配置
├── .env.production    # 生产环境配置
├── vite.config.js     # Vite配置
└── package.json       # 依赖管理
```

## 技术栈

### 后端

- Gin：Web框架
- GORM：ORM框架
- Casbin：权限管理
- JWT：身份认证
- MSSQL/MySQL/PostgreSQL：数据库

### 前端

- Vue3：前端框架
- Element Plus：UI组件库
- Pinia：状态管理
- Vue-Router：路由管理
- Axios：HTTP客户端

## 相关文档

- [开发计划](./README-plan.md)：详细的开发计划和进度安排
- [后端文档](./server/README-serve.md)：后端模块和功能说明
- [前端文档](./web/README-web.md)：前端组件和功能说明
- [开发指南](./开发指南.md)：项目开发规范和指导

## 安装和启动指南

### 后端安装和运行

```bash
# 1. 进入服务端目录
cd server

# 2. 安装Go依赖 (所有依赖本地引用，非外部CDN)
go mod tidy

# 3. 修改配置文件
# 编辑 configs/config.yaml 配置数据库连接信息

# 4. 运行开发服务器
# Windows环境
scripts/run.bat
# Linux/macOS环境
bash scripts/run.sh

# 5. 构建生产版本
# Windows环境
scripts/build.bat
# Linux/macOS环境
bash scripts/build.sh
```

### 前端安装和运行

```bash
# 1. 进入前端目录
cd web

# 2. 安装依赖 (所有依赖本地引用，非外部CDN)
npm install

# 3. 修改环境配置 (如需要)
# 编辑 .env.development 和 .env.production 文件

# 4. 运行开发服务器
npm run dev

# 5. 构建生产版本
npm run build
```

> **重要说明**：项目所有前后端依赖均为本地引用，不使用外部CDN，确保系统在内网环境也能正常运行。

## 许可证

MIT