diff --git a/README.md b/README.md index b1d35df0376d4d65bdd778bfcf0109e5ac4623a7..6c4b8cfe7b01a14eca104e3a863d3b3577604a6a 100644 --- a/README.md +++ b/README.md @@ -1,143 +1,135 @@ -

- logo -

-

RuoYi-Go v1.0.0

-

基于gin+Vue Go快速开发框架

-

- - - -

- -## 项目介绍 -🎉 基于Go，gin，JWT，vue前后端分离的权限管理系统，同时提供了 原生Android 的版本！！！ -* 前端采用Vue2 & ElementUI。 -* 后端采用go、gin & Jwt & gorm & mysql & copier & redis & gin-cache && xxl-job。 -* 权限认证使用Jwt，支持多终端认证系统。 - -## 在线体验 - -- admin/admin123 -- 陆陆续续收到一些打赏，为了更好的体验已用于演示服务器升级。谢谢各位小伙伴。 - -文档地址: https://ruoyi-go.qiqjia.com - -## 演示图 -访问地址：http://127.0.0.1:8080/old#/ - - - - - - - - - - - - - - - - - -
- -## 演示图(新版本) -访问地址：http://127.0.0.1:8080/#/ - - - - - - - - - - - - - - - - - -
- -## 后台接口开发 -- 用户管理 -- 菜单管理 -- 角色管理 -- 字典管理 -- 日志管理 -- job管理（无参）完成 -- 配置管理 -- 部门管理 -- 通知管理 -- 缓存列表 -- 在线用户 -- 缓存监控（待） -- 服务监控（待）有bug -- 操作日志-统一接口处理 -- 错误日志处理 -- xxl-job管理（demo成功） -- 代码生成器Go版本完成 - -## 安装 -1.导入sql到mysql -数据库文件： -- sql/ry-go.sql -- 去掉了qrtz_xx 系列表； -- sql/ry-job.sql -- xxljob功能项目 - 后台前端地址：https://gitee.com/y_project/RuoYi-Vue/tree/master/ruoyi-ui - 已修改访问地址，在view/admin 文件夹中 - -2.拉取依赖 -> go mod tidy - -错误信息timeout。 -自动下载 -go env -w GO111MODULE=on -设置环境为国内代理 -go env -w GOPROXY=https://goproxy.cn,direct - - -3.创建.env文件以及配置 -> cat config/config.yaml.example > config.yaml -配置用户名和密码以及端口号等信息 - -## 启动 -```shell -go run main.go -``` - - -## 后台页面功能概览 -访问地址：http://127.0.0.1:8080/admin - - - - - - - - - - - - - - - - - - - - - - - - - - - -
\ No newline at end of file +Ruoyi-Go 项目介绍 +==================== + +## 项目概述 + +Ruoyi-Go 是一个基于 Go 语言的后端管理系统，结合 Gin 框架和一系列现代工具，提供了一套完整的 Web 解决方案。该项目旨在为开发者提供一个高效、稳定、易于扩展的基础框架，适用于企业级应用开发。 + +## 功能模块 + +### 后台功能概览 + +- **用户管理**：支持用户登录、权限分配、角色管理、密码修改等功能。 +- **角色管理**：支持角色创建、权限分配、数据范围设置等。 +- **菜单管理**：支持菜单的增删改查，以及菜单权限配置。 +- **部门管理**：支持部门结构的维护与权限控制。 +- **岗位管理**：管理岗位信息，支持岗位与用户的绑定。 +- **通知公告**：发布系统通知和公告。 +- **系统参数配置**：支持系统参数的动态配置与缓存刷新。 +- **定时任务**：支持任务调度、日志记录、任务执行状态监控。 +- **系统监控**： + - **在线用户管理**：查看当前在线用户并进行强制下线操作。 + - **日志管理**：包括登录日志、操作日志、任务日志等。 + - **服务状态监控**：获取服务器运行状态（CPU、内存、JVM、磁盘等）。 +- **缓存管理**：支持缓存的查看、清除等操作。 +- **代码生成器**：通过数据库表结构自动生成前后端代码，提升开发效率。 +- **文件上传**：支持文件上传、下载、预览等功能。 +- **国际化支持**：支持多语言切换，适配不同地区用户需求。 + +## 技术栈 + +- **后端**：Go + Gin 框架 +- **数据库**：MySQL、Redis +- **缓存**：支持 Redis、ristretto 等缓存组件 +- **前端**：Vue.js + Element UI（后台管理界面）、uni-app（移动端） +- **部署**：Docker + Docker Compose +- **其他工具**：Swagger（API 文档）、JWT（身份验证）、XXL-JOB（任务调度） + +## 安装与部署 + +### 环境要求 + +- Go 1.16+ +- MySQL 5.7+ +- Redis 6.0+ +- Node.js（前端构建） +- Docker（可选，用于部署） + +### 安装步骤 + +1. **克隆项目** + + ```bash + git clone https://gitee.com/OptimisticDevelopers/Ruoyi-Go.git + cd Ruoyi-Go + ``` + +2. **配置数据库** + + - 创建数据库 `ry-go`，导入 `sql/ry-go.sql` 和 `sql/ry-job.sql` + - 修改 `config/config.yaml` 中的数据库连接信息 + +3. **配置 Redis** + + - 修改 `config/config.yaml` 中的 Redis 配置 + +4. **启动服务** + + ```bash + go run main.go + ``` + +5. **构建 Docker 镜像（可选）** + + ```bash + docker build -t ruoyi-go . + docker run -d -p 8080:8080 ruoyi-go + ``` + +6. **前端部署** + + - 进入前端目录并安装依赖 + + ```bash + cd frontend/ruoyi-ui + npm install + npm run serve + ``` + + - 构建生产环境包 + + ```bash + npm run build:prod + ``` + +## 使用说明 + +### 登录系统 + +- 默认账号：`admin` +- 默认密码：`admin123` + +### 接口文档 + +- 使用 Swagger 查看 API 文档：`http://localhost:8080/swagger/index.html` + +### 代码生成器 + +- 支持通过数据库表结构自动生成前后端代码，提升开发效率。 + +### 定时任务 + +- 使用 XXL-JOB 实现分布式任务调度，支持任务日志记录和执行状态追踪。 + +## 开发规范 + +- **代码结构清晰**：采用模块化设计，便于维护和扩展。 +- **日志记录**：使用 logrus 和 zap 实现详细的日志记录。 +- **权限控制**：基于 JWT 的身份认证和基于角色的访问控制（RBAC）。 +- **缓存机制**：支持多种缓存策略，提升系统性能。 +- **错误处理**：统一的错误返回格式，便于调试和前端处理。 + +## 贡献指南 + +欢迎贡献代码和文档，提交 PR 前请确保： +- 代码符合 Go 编码规范 +- 提交前进行单元测试 +- 更新相关文档 + +## 许可证 + +本项目采用 MIT 许可证，请查看 [LICENSE](LICENSE) 文件了解详细信息。 + +--- + +如需了解更多，请参考 [README.md](README.md) 或访问 [Gitee 项目主页](https://gitee.com/OptimisticDevelopers/Ruoyi-Go)。 \ No newline at end of file