docs: 更新README文档

2024-01-29 19:52:11 +08:00
parent 5b960fd5ab
commit cee335c7c6
2 changed files with 172 additions and 63 deletions
--- a/README.md
+++ b/README.md
@@ -1,39 +1,184 @@
-# RuoYi-Vue3-FastAPI
+<p align="center">
+	<img alt="logo" src="https://oscimg.oschina.net/oscnet/up-d3d0a9303e11d522a06cd263f3079027715.png">
+</p>
+<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">RuoYi-Vue3-FastAPI v1.0.0</h1>
+<h4 align="center">基于RuoYi-Vue3+FastAPI前后端分离的快速开发框架</h4>
+<p align="center">
+	<a href="https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI/stargazers"><img src="https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI/badge/star.svg?theme=dark"></a>
+    <a href="https://github.com/insistence/RuoYi-Vue3-FastAPI"><img src="https://img.shields.io/github/stars/insistence/RuoYi-Vue3-FastAPI?style=social"></a>
+	<a href="https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI"><img src="https://img.shields.io/badge/RuoYiVue3FastAPI-v1.0.0-brightgreen.svg"></a>
+	<a href="https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mashape/apistatus.svg"></a>
+    <img src="https://img.shields.io/badge/python-≥3.8-blue">
+    <img src="https://img.shields.io/badge/MySQL-≥5.7-blue">
+</p>

-#### 介绍
-{**以下是 Gitee 平台说明，您可以替换此简介**
-Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
-无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
+## 平台简介

-#### 软件架构
-软件架构说明
+RuoYi-Vue-FastAPI是一套全部开源的快速开发平台，毫无保留给个人及企业免费使用。

+* 前端采用Vue、Element Plus，基于<u>[RuoYi-Vue3](https://github.com/yangzongzhuan/RuoYi-Vue3)</u>前端项目修改。
+* 后端采用FastAPI、sqlalchemy、MySQL、Redis、OAuth2 & Jwt。
+* 权限认证使用OAuth2 & Jwt，支持多终端认证系统。
+* 支持加载动态权限菜单，多方式轻松权限控制。
+* Vue2版本：
+  - Gitte仓库地址：https://gitee.com/insistence2022/RuoYi-Vue-FastAPI。
+  - GitHub仓库地址：https://github.com/insistence/RuoYi-Vue-FastAPI。
+* 纯Python版本：
+  - Gitte仓库地址：https://gitee.com/insistence2022/dash-fastapi-admin。
+  - GitHub仓库地址：https://github.com/insistence/Dash-FastAPI-Admin。
+* 特别鸣谢：<u>[RuoYi-Vue3](https://github.com/yangzongzhuan/RuoYi-Vue3)</u>。

-#### 安装教程
+## 内置功能

-1.  xxxx
-2.  xxxx
-3.  xxxx
+1.  用户管理：用户是系统操作者，该功能主要完成系统用户配置。
+2.  角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。
+3.  菜单管理：配置系统菜单，操作权限，按钮权限标识等。
+4.  部门管理：配置系统组织机构（公司、部门、小组）。
+5.  岗位管理：配置系统用户所属担任职务。
+6.  字典管理：对系统中经常使用的一些较为固定的数据进行维护。
+7.  参数管理：对系统动态配置常用参数。
+8.  通知公告：系统通知公告信息发布维护。
+9.  操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。
+10. 登录日志：系统登录日志记录查询包含登录异常。
+11. 在线用户：当前系统中活跃用户状态监控。
+12. 定时任务：在线（添加、修改、删除）任务调度包含执行结果日志。
+13. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
+14. 缓存监控：对系统的缓存信息查询，命令统计等。
+15. 系统接口：根据业务代码自动生成相关的api接口文档。

-#### 使用说明
+## 演示图

-1.  xxxx
-2.  xxxx
-3.  xxxx
+<table>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/login.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/dashboard.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/user.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/role.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/menu.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/dept.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/post.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/dict.png"/></td>
+    </tr>	 
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/config.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/notice.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/operLog.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/loginLog.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/online.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/job.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/server.png"/></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/cache.png"/></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/cacheList.png"></td>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/api.png"></td>
+    </tr>
+    <tr>
+        <td><img src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/profile.png"/></td>
+    </tr>
+</table>

-#### 参与贡献
+## 在线体验
+- *账号：admin*
+- *密码：admin123*
+- 演示地址：<a href="https://vfadmin.insistence.tech">vfadmin管理系统<a>

-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+## 项目开发及发布相关

+### 开发

-#### 特技
+```bash
+# 克隆项目
+git clone https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI.git

-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+# 进入项目根目录
+cd RuoYi-Vue3-FastAPI
+```
+
+#### 前端
+```bash
+# 进入前端目录
+cd ruoyi-fastapi-frontend
+
+# 安装依赖
+npm install 或 yarn --registry=https://registry.npmmirror.com
+
+# 建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
+npm install --registry=https://registry.npmmirror.com
+
+# 启动服务
+npm run dev 或 yarn dev
+```
+
+#### 后端
+```bash
+# 进入后端目录
+cd ruoyi-fastapi-backend
+
+# 安装项目依赖环境
+pip3 install -r requirements.txt
+
+# 配置环境
+在.env.dev文件中配置开发环境的数据库和redis
+
+# 运行sql文件
+1.新建数据库ruoyi-fastapi(默认，可修改)
+2.使用命令或数据库连接工具运行sql文件夹下的ruoyi-fastapi.sql
+
+# 运行后端
+python3 app.py --env=dev
+```
+
+#### 访问
+```bash
+# 默认账号密码
+账号：admin
+密码：admin123
+
+# 浏览器访问
+地址：http://localhost:80
+```
+
+### 发布
+
+#### 前端
+```bash
+# 构建测试环境
+npm run build:stage 或 yarn build:stage
+
+# 构建生产环境
+npm run build:prod 或 yarn build:prod
+```
+
+#### 后端
+```bash
+# 配置环境
+在.env.prod文件中配置生产环境的数据库和redis
+
+# 运行后端
+python3 app.py --env=prod
+```
+
+## 交流与赞助
+如果有对本项目及FastAPI感兴趣的朋友，欢迎加入知识星球一起交流学习，让我们一起变得更强。如果你觉得这个项目帮助到了你，你可以请作者喝杯咖啡表示鼓励☕。扫描下面微信二维码添加微信备注VF-Admin即可进群。
+<table>
+    <tr>
+        <td><img alt="zsxq" src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/zsxq.jpg"></td>
+        <td><img alt="zanzhu" src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/zanzhu.jpg"></td>
+    </tr>
+    <tr>
+        <td><img alt="wxcode" src="https://gitee.com/insistence2022/RuoYi-Vue-FastAPI/raw/master/demo-pictures/wxcode.jpg"></td>
+    </tr>
+</table>