修改项目文档

This commit is contained in:
izory 2021-09-25 09:30:46 +08:00
parent b70ab3cd85
commit 8e7c1df8a1
3 changed files with 55 additions and 46 deletions

View File

@ -9,15 +9,18 @@
* 权限认证使用Jwt支持多终端认证系统。 * 权限认证使用Jwt支持多终端认证系统。
* 支持加载动态权限菜单,多方式轻松权限控制 * 支持加载动态权限菜单,多方式轻松权限控制
> 如果对您有帮助,您可以点右上角 “Star” 收藏一下 ,这样作者才有继续免费下去的动力,谢谢!~ ```
如果对您有帮助,您可以点右上角 “Star” 收藏一下 ,这样作者才有继续免费下去的动力,谢谢!~
```
## 🍿在线体验 ## 🍿在线体验
体验地址http://www.izhaorui.cn:8080/ - 体验地址http://www.izhaorui.cn:8080/
管理员admin - 管理员admin
密 码123456 - 密 码123456
**由于是个人项目,资金有限,体验服是低配,请大家爱惜,轻戳,不胜感激!!!**
```
由于是个人项目,资金有限,体验服是低配,请大家爱惜,轻戳,不胜感激!!!
```
## 🍁前端技术 ## 🍁前端技术
Vue版前端技术栈 基于vue、vuex、vue-router 、vue-cli 、axios 和 element-ui前端采用vscode工具开发 Vue版前端技术栈 基于vue、vuex、vue-router 、vue-cli 、axios 和 element-ui前端采用vscode工具开发
@ -34,7 +37,7 @@ Vue版前端技术栈 基于vue、vuex、vue-router 、vue-cli 、axios 和 e
## 🍄快速启动 ## 🍄快速启动
需要安装VS2019最新版、npm或yarn最新版 需要安装VS2019最新版、npm或yarn最新版
准备工作将document文件夹下面的admin.sql脚本导入到数据库中修改ZR.Admin.WebApi项目里面配置文件中的conn_zrAdmin数据库连接字符串以及DbType选择对应的数据库类型目前仅支持MySQL、SQL server 准备工作将document文件夹下面的admin.sql脚本导入到数据库中修改appsettings.json配置文件里面中的conn_zrAdmin数据库连接字符串以及conn_zrAdmin_Type选择对应的数据库类型目前仅支持MySQL、SQL server
启动后台打开项目根目录的startup.bat即可启动数据库默认MySQL 启动后台打开项目根目录的startup.bat即可启动数据库默认MySQL
启动前端打开ZR.Vue文件夹运行npm install命令再运行npm run serve启动 启动前端打开ZR.Vue文件夹运行npm install命令再运行npm run serve启动
浏览器访问http://localhost:8887 默认前端端口为8887后台端口为8888 浏览器访问http://localhost:8887 默认前端端口为8887后台端口为8888
@ -42,43 +45,47 @@ Vue版前端技术栈 基于vue、vuex、vue-router 、vue-cli 、axios 和 e
## 🍖内置功能 ## 🍖内置功能
1. [X] 用户管理:用户是系统操作者,该功能主要完成系统用户配置。 1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
2. [X] 部门管理:配置系统组织机构(公司、部门、小组),树结构展现。 2. 部门管理:配置系统组织机构(公司、部门、小组),树结构展现。
3. [X] 岗位管理:配置系统用户所属担任职务。 3. 岗位管理:配置系统用户所属担任职务。
4. [X] 菜单管理:配置系统菜单,操作权限,按钮权限标识等。 4. 菜单管理:配置系统菜单,操作权限,按钮权限标识等。
5. [X] 角色管理:角色菜单权限分配。 5. 角色管理:角色菜单权限分配。
6. [X] 字典管理:对系统中经常使用的一些较为固定的数据进行维护。 6. 字典管理:对系统中经常使用的一些较为固定的数据进行维护。
7. [ ] 参数管理:对系统动态配置常用参数。 6. 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
8. [X] 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。 7. 登录日志:系统登录日志记录查询包含登录异常。
9. [X] 登录日志:系统登录日志记录查询包含登录异常。 8. 系统接口使用swagger生成相关api接口文档。
10. [ ] 在线用户:当前系统中活跃用户状态监控。 9. 服务监控监视当前系统CPU、内存、磁盘、堆栈等相关信息。
11. [X] 系统接口使用swagger生成相关api接口文档。 10. 在线构建器拖动表单元素生成相应的VUE代码。
12. [X] 服务监控监视当前系统CPU、内存、磁盘、堆栈等相关信息。 11. 任务系统基于Quartz.NET定时任务执行。
13. [X] 在线构建器拖动表单元素生成相应的VUE代码。 12. 文章管理:可以写文章记录。
14. [X] 任务系统基于Quartz.NET定时任务执行。 13. 代码生成:可以一键生成前后端代码(.cs、.vue、.js),自定义配置前端展示控件、让开发更快捷高效。
15. [X] 文章管理:可以写文章记录。
16. [X] 代码生成:可以一键生成前后端代码(.cs、.vue、.js),自定义配置前端展示控件、让开发更快捷高效。
## 项目结构
ZRAdmin解决方案包含 ## 🍻项目结构
ZR.Service[服务层类库]提供WebApi接口调用 ```
- ZR.Service[服务层类库]提供WebApi接口调用
- ZR.Repository[仓库层类库]:方便提供有执行存储过程的操作;
- ZR.Model[实体层类库],提供项目中的数据库表、数据传输对象;
- ZR.Admin.WebApi[webapi接口]为Vue版或其他三方系统提供接口服务。
- ZR.Vue[前端UI]vue版本UI层。
- ZR.Tasks[定时任务类库]:提供项目定时任务实现功能;
- ZR.CodeGenerator[代码生成功能],包含代码生成的模板、方法、代码生成的下载。
```
## ⚡ 近期计划
ZR.Tasks[定时任务类库]:提供项目定时任务实现功能; - [ ] 参数管理
- [ ] 在线用户
- [ ] 文件管理
- [ ] 邮件发送
- [ ] 集成微信开发
ZR.Repository[仓库层类库]:方便提供有执行存储过程的操作; ## 📖 帮助文档
👉快捷部署到Linux文档
ZR.Model[实体层类库],提供项目中的数据库表、数据传输对象; - [本地md文件](./document/nginx部署文档.md "代码生成")
ZR.CodeGenerator[代码生成功能],包含代码生成的模板、方法、代码生成的下载。
ZR.Admin.WebApi[webapi接口]为Vue版或其他三方系统提供接口服务。
ZR.Vue[前端UI]vue版本UI层。
DataBase是最新数据库备份文件目前支持MS SQL Server和MySql。
👉代码生成器使用教程:
- [本地md文件](./document/代码生成器使用.md "代码生成")
## 🍎演示图 ## 🍎演示图
@ -115,6 +122,9 @@ DataBase是最新数据库备份文件目前支持MS SQL Server和MySql。
<td><img src="https://www.izhaorui.cn/images/zradmin/15.png"/></td> <td><img src="https://www.izhaorui.cn/images/zradmin/15.png"/></td>
<td><img src="https://www.izhaorui.cn/images/zradmin/16.png"/></td> <td><img src="https://www.izhaorui.cn/images/zradmin/16.png"/></td>
</tr> </tr>
<tr>
<td><img src="https://www.izhaorui.cn/images/zradmin/17.png"/></td>
</tr>
</table> </table>
## 🎉优势 ## 🎉优势
@ -127,15 +137,9 @@ DataBase是最新数据库备份文件目前支持MS SQL Server和MySql。
## 💐 特别鸣谢 ## 💐 特别鸣谢
- 👉Ruoyi.vue[Ruoyi](http://www.ruoyi.vip/) - 👉Ruoyi.vue[Ruoyi](http://www.ruoyi.vip/)
- 👉SqlSugarhttps://gitee.com/dotnetchina/SqlSugar - 👉SqlSugar[SqlSugar]https://gitee.com/dotnetchina/SqlSugar
## 🍻参与贡献 ## 😎联系作者
- Fork 本项目
- 新建 Feat_xxx 分支
- 提交代码
- 新建 Pull Request
## 联系作者
QQ599854767 QQ599854767
## 🎀捐赠 ## 🎀捐赠

View File

@ -0,0 +1 @@
## nginx部署文档.md

View File

@ -0,0 +1,4 @@
## 代码生成器使用教程
👉视频教程:
- [观看视频](./images/代码生成演示202109250747.mp4)