diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..0009ecc --- /dev/null +++ b/docs/README.md @@ -0,0 +1,36 @@ +## 项目介绍 +**
ZrAdmin.NET
** +
前后端分离模式，基于Net5 、vue2.0、ElementUI、jwt通用后台权限管理系统
+ +
+ +![licene](https://img.shields.io/github/license/mashape/apistatus.svg) +[![stars](https://gitee.com/izory/ZrAdminNetCore/badge/star.svg?theme=dark)](https://gitee.com/izory/ZrAdminNetCore) +[![fork](https://gitee.com//izory/ZrAdminNetCore/badge/fork.svg?theme=dark)](https://gitee.com/izory/ZrAdminNetCore/members) +
+ +* 本项目适合有一定NetCore和 vue基础的开发人员 +* 基于.NET 5实现的通用权限管理平台（RBAC模式）。整合最新技术高效快速开发，前后端分离模式，开箱即用。 +* 代码量少、学习简单、通俗易懂、功能强大、易扩展、轻量级，让web开发更快速、简单高效，解决70%的重复工作，专注您的业务，轻松开发从现在开始！ +* 前端采用Vue2.0、Element UI。 +* 后端采用Net5、Sqlsugar、MySQL。 +* 权限认证使用Jwt，支持多终端认证系统。 +* 支持加载动态权限菜单，多方式轻松权限控制 + +!> 如果对您有帮助，您可以点右上角⭐Star⭐ 收藏一下 ，这样作者才有继续免费下去的动力，谢谢！~ + +## 在线体验 + +- 演示地址：http://www.izhaorui.cn:8080 +- 账号密码：admin/123456 + +!> 由于是个人项目，资金有限，体验服是低配，请大家爱惜，轻戳，不胜感激！！！ + +## 技术交流群 +- 191349103 + +## 捐赠支持 +!> Donate
+ 如果你觉得这个项目帮助到了你，你可以请作者喝杯咖啡表示鼓励 ☕️ + +![donate](https://gitee.com/izory/ZrAdminNetCore/raw/master/document/images/pay.jpg ':size=80%') diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 0000000..a3da634 --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,13 @@ + + +# ZrAdmin.NET 3.1 + + +- ZrAdmin.NET是一款基于 .Net5 + vue的快速开发框架。 + +[GitHub](https://github.com/izhaorui/ZrAdmin.NET) +[Gitee](https://gitee.com/izory/ZrAdminNetCore) +[快速开始](#项目介绍) \ No newline at end of file diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..18cb801 --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,16 @@ +# 文档 +## 介绍 + +## 快速了解 + +## 环境部署 + +## 项目介绍 + +## 后台手册 + +## 前端手册 + +## 功能组件 + +## 代码生成器 \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..2807778 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,12 @@ + +- **文档** + +- * [项目介绍](/#项目介绍) +- * [快速了解](/understand.md) +- * [环境部署](/hjbs.md#环境部署) +- * [后台手册](/htsc.md#后台手册) +- * [前端手册](/qdsc.md#前端手册) + +- **其他** +- * [常见问题](/faq.md#常见问题) +- * [🎀捐赠支持](/#捐赠支持) \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..d1fcfe0 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1 @@ +!> 努力构建中... \ No newline at end of file diff --git a/docs/guard.md b/docs/guard.md new file mode 100644 index 0000000..dcad2c5 --- /dev/null +++ b/docs/guard.md @@ -0,0 +1,19 @@ +# 文档 +## 介绍 + +> An awesome project. + + +## 快速了解 + +## 环境部署 + +## 项目介绍 + +## 后台手册 + +## 前端手册 + +## 功能组件 + +## 代码生成器 \ No newline at end of file diff --git a/docs/hjbs.md b/docs/hjbs.md new file mode 100644 index 0000000..54b7583 --- /dev/null +++ b/docs/hjbs.md @@ -0,0 +1,152 @@ +# 环境部署 +## 准备工作 + +``` +NetCore >= 5.0 +MySql >= 5.7.0 +Node >= 10 +``` + +!> 前端安装完node后，最好设置下淘宝镜像源，不建议使用cnpm(可能会出现奇怪的问题) +``` node +npm install --registry=https://registry.npm.taobao.org +``` + +## 运行系统 + +前往 Gitee 下载页面(https://gitee.com/izory/ZrAdminNetCore) 下载本项目 + +## 后端运行 +1. 创建数据库 zrAdmin 将项目根目录下面的document文件夹下的选择对应的数据库类型脚本admin-xxxx.sql并导入数据脚本 +2. 修改appsettings.json配置文件中的conn_zrAdmin数据库连接字符串以及 - conn_zrAdmin_Type选择对应的数据库类型，目前仅支持MySQL、SQL server +3. 打开项目运行F5 ，出现如下图表示启动成功。 +4. 通过项目根目录中的startup.bat启动 + +``` C# +info: Microsoft.Hosting.Lifetime[0] + Now listening on: http://localhost:8888 +info: Microsoft.Hosting.Lifetime[0] + Application started. Press Ctrl+C to shut down. +10-11 17:51:31 | INFO | Microsoft.Hosting.Lifetime | | | Now listening on: http://localhost:8888 +info10-11 17:51:31 | INFO | Microsoft.Hosting.Lifetime | | | Application started. Press Ctrl+C to shut down. +10-11 17:51:31 | INFO | Microsoft.Hosting.Lifetime | | | Hosting environment: Stage +10-11 17:51:31 | INFO | Microsoft.Hosting.Lifetime | | | Content root path: F:\ZRAdmin.NET\ZR.Admin.WebApi +``` + +!> 后端运行成功可以通过(http://localhost:8888) 访问，但是不会出现静态页面，可以继续参考下面步骤部署前端，然后通过前端地址来访问。 + +## 前端运行 +``` node +# 进入项目目录 +cd ZR.Vue + +# 安装依赖 +npm install + +# 强烈建议不要用直接使用 cnpm 安装，会有各种诡异的 bug，可以通过重新指定 registry 来解决 npm 安装速度慢的问题。 +npm install --registry=https://registry.npm.taobao.org + +# 本地开发 启动项目 +npm run dev +``` +4. 打开浏览器，输入：(http://localhost:8887 ) 默认账户/密码 admin/123456） +若能正确展示登录页面，并能成功登录，菜单及页面展示正常，则表明环境搭建成功 + +## 必要配置 +- 修改数据库连接编辑ZR.Admin.WebApi目录下的appsettings.json 配置 + +``` json +{ + "ConnectionStrings": { + "conn_zrAdmin": "server=127.0.0.1;user=zr;pwd=abc123;database=zrAdmin", //修改成你的数据库连接字符串 + }, + "conn_zrAdmin_type": 0, //选择对应的数据库类型MySql = 0, SqlServer = 1 +} +``` +- 跨域配置 +```json +{ + "sysConfig": { + "tokenExpire": 1440, //Jwt token超时时间（分） + "cors": "http://localhost:8887" //跨域地址，配置前端启动地址多个用","隔开 + } +} +``` + +## 部署系统 +### 后端部署 +- 发布WebApi项目文件 +vs打开项目后 右键 ZR.Admin.WebApi 选择发布即可，将发布后的文件拷贝到服务器上 + +### 前端部署 +``` sh +# 打包正式环境 +npm run build:prod + +# 打包预发布环境 +npm run build:stage +``` + +构建打包成功之后，会在根目录生成 dist 文件夹，里面就是构建打包好的文件，通常是 ***.js 、***.css、index.html 等静态文件。 + +通常情况下 dist 文件夹的静态文件发布到你的 nginx 或者静态服务器即可，其中的 index.html 是后台服务的入口页面。 + +## 环境变量 +所有测试环境或者正式环境变量的配置都在 .env.development等 .env.xxxx文件中。 + +它们都会通过 webpack.DefinePlugin 插件注入到全局。 + +!> 环境变量必须以VUE_APP_为开头。如:VUE_APP_API、VUE_APP_TITLE
+ 你在代码中可以通过如下方式获取:
+ console.log(process.env.VUE_APP_xxxx) + + +## Nginx配置 +1. 创建文件 zradmin.ini 添加以下内容 + +```nginx +server { + #修改要监听的端口 + listen 8080; + #修改要绑定的域名或IP地址 + server_name localhost; + + # charset koi8-r; + access_log logs/logs.access.log main; + + # 后端接口 生产环境 + location /prod-api/ { + proxy_pass http://localhost:8888/; + + # 后端的Web服务器可以通过X-Forwarded-For获取用户真实IP + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # 如果请求被负载均衡的服务器返回类似500这样的，将继续请求下一台应用服务器，默认 对post,lock,patch的请求不进行重试，如果要设置在后面添加 non_idemponent + # proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504; + } + + # vue项目配置 + location / { + #将xxxxx路径改成你的发布路径 + root html/zradmin_vue; + index index.html; + try_files $uri $uri/ /index.html; + } + + error_page 404 /404.html; + + # redirect server error pages to the static page /50x.html + error_page 500 502 503 504 /50x.html; + location = /50x.html { + root html; + } +} +``` +2. 在nginx安装目录中的html目录中创建文件夹zradmin_vue + +4. 将ZR.Vue项目的dist文件中的文件拷贝到刚刚创建的zradmin_vue中 +5. 浏览器中访问 http://localhost:8080 + +!> 服务器防火墙的设置开放8080 端口 \ No newline at end of file diff --git a/docs/htsc.md b/docs/htsc.md new file mode 100644 index 0000000..0caab37 --- /dev/null +++ b/docs/htsc.md @@ -0,0 +1,17 @@ +## 👉代码生成 +- 修改配置文件appsettings.json +``` json +"gen": { + "conn": "server=127.0.0.1;user=zr;pwd=abc;database={database}", //代码生成数据库连接字符串 + "dbType": 0, //MySql = 0, SqlServer = 1 + "autoPre": true, //自动去除表前缀 + "author": "zr", + "tablePrefix": "sys_" //"表前缀（生成类名不会包含表前缀，多个用","分隔）", + } +``` +修改conn数据库连接字符串其中{database}为动态要替换的数据库名 + + + +👉视频教程 +- [观看视频](http://ss.izhaorui.cn/zradmin/%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E6%BC%94%E7%A4%BA202109250747.mp4) diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..5643208 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,43 @@ + + + + + Document + + + + + + + +
+ + + + + + + + diff --git a/docs/qdsc.md b/docs/qdsc.md new file mode 100644 index 0000000..0fbd2e3 --- /dev/null +++ b/docs/qdsc.md @@ -0,0 +1,3 @@ +## 前端手册 + +> 敬请期待 \ No newline at end of file diff --git a/docs/understand.md b/docs/understand.md new file mode 100644 index 0000000..f5139b9 --- /dev/null +++ b/docs/understand.md @@ -0,0 +1,45 @@ +# 快速了解 + +## 项目简介 + +ZrAdmin.NET是一款基于 .Net5 + vue的快速开发框架。 +- ZrAdmin.NET在线文档：http://www.izhaorui.cn/doc +- ZrAdmin.NET源码地址：https://gitee.com/izory/ZrAdminNetCore +- ZrAdmin.NET在线提问：https://gitee.com/izory/ZrAdminNetCore/issues +- QQ群号：191349103 + +## 主要特征 +- 完全响应式布局（支持电脑、平板、手机等所有主流设备） +- 强大的一键生成功能（包括控制器、模型、视图、菜单等） +- 支持多数据源，简单配置即可实现切换。 +- 支持按钮及数据权限，可自定义部门数据权限。 +- 完善的日志记录体系简单注解即可实现 +- 支持服务监控。 + +## 技术选型 +- vue2.0 +- sqlsugar +- .Net5 +- element-ui + +## 开发工具 +- vscode +- vs2019 + +## 内置功能 + +1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。 +2. 部门管理：配置系统组织机构（公司、部门、小组），树结构展现。 +3. 岗位管理：配置系统用户所属担任职务。 +4. 菜单管理：配置系统菜单，操作权限，按钮权限标识等。 +5. 角色管理：角色菜单权限分配。 +6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。 +6. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 +7. 登录日志：系统登录日志记录查询包含登录异常。 +8. 系统接口：使用swagger生成相关api接口文档。 +9. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。 +10. 在线构建器：拖动表单元素生成相应的VUE代码。 +11. 定时任务：基于Quartz.NET定时任务执行。 +12. 文章管理：可以写文章记录。 +13. 代码生成：可以一键生成前后端代码(.cs、.vue、.js、sql)，自定义配置前端展示控件、让开发更快捷高效。 +14. 参数管理：对系统动态配置常用参数。 \ No newline at end of file