docs: 完善文档

This commit is contained in:
yubaolee 2025-06-08 11:43:41 +08:00
parent 18cbbc6fea
commit 18f94787e0
2 changed files with 18 additions and 31 deletions

View File

@ -7,11 +7,13 @@ permalink: /core/
<img src="/logocore.png" alt="1.png" style="width: 300px; height: auto; display: inline-block;" />
</div>
OpenAuth.Net是基于最新版.Net的开源权限工作流快速开发框架。源于Martin Fowler企业级应用开发思想及最新技术组合SqlSugar、EF、Quartz、AutoFac、WebAPI、Swagger、Mock、NUnit、Vue2/3、Element-ui/plus、IdentityServer等。核心模块包括角色授权、代码生成、API鉴权、智能打印、表单设计、工作流、定时任务等。
OpenAuth.Net是基于最新版.Net的开源权限工作流快速开发框架。源于Martin Fowler企业级应用开发思想及最新技术组合SqlSugar、EF、Quartz、AutoFac、WebAPI、Swagger、Mock、NUnit、Vue2/3、Element-ui/plus、IdentityServer等。核心模块包括角色授权、代码生成、API鉴权、智能打印、表单设计、工作流、定时任务等。系统整体架构如下:
开源Vue2演示[http://demo.openauth.net.cn:1803/](http://demo.openauth.net.cn:1803/)
![系统架构](http://img.openauth.net.cn/系统架构.png)
如果你想了解企业版的内容,请访问:[http://doc.openauth.net.cn/pro](http://doc.openauth.net.cn/pro/)
开源版演示:[http://demo.openauth.net.cn:1803/](http://demo.openauth.net.cn:1803/)
如果你想了解vue3版本的内容请访问[http://doc.openauth.net.cn/pro](http://doc.openauth.net.cn/pro/)
::: tip 提示
@ -54,7 +56,7 @@ gitee上面两个版本。其中
* 建立三方对接规范,已有系统可以无缝对接流程引擎
* 前端采用 vue + layui + element-ui + ztree + gooflow + leipiformdesign
* 前端采用 vue + element-ui + ztree + gooflow + leipiformdesign
* 后端采用 .net +EF + sqlsugar + autofac + quartz +IdentityServer4 + nunit + swagger

View File

@ -6,43 +6,24 @@ permalink: /core/start/
## 下载代码
gitee上面两个版本。其中
* [OpenAuth.Net](https://gitee.com/dotnetchina/OpenAuth.Net) 默认SDK版本为.Net 9.0.100,如果需要切换到.Net其他版本请参考[切换sdk版本](http://doc.openauth.net.cn/core/changesdk/)
* [OpenAuth.Core](https://gitee.com/yubaolee/OpenAuth.Core) 的SDK版本为.Net Core 3.1.100,已停止维护,不推荐使用。
.Net目前SDK升级特别方便。请参考[3分钟的时间把.net core 3.1的升级到.NET 5](https://www.cnblogs.com/yubaolee/p/Net3ToNet5.html)所以不要纠结SDK版本问题。
## 系统架构
![系统架构](http://img.openauth.net.cn/系统架构.png)
## 安装sdk
下载安装微软官方SDK代码地址https://dotnet.microsoft.com/download
## 项目结构
OpenAuth.Net文件夹结构及功能说明如下
OpenAuth.Net源码可以从[https://gitee.com/dotnetchina/OpenAuth.Net](https://gitee.com/dotnetchina/OpenAuth.Net) 下载。下载完成后可以看到文件夹结构如下:
```
📦OpenAuth.Net
┣ 📂CodeSmith
┃ ┗ 📂CSharp
┃ ┃ ┗ 📜WebGenerate.cst //生成Web页面
┣ 📂.cursor //cursor rules、MCP配置
┣ 📂newdocs //文档
┣ 📂Infrastructure //基础工具类
┣ 📂mysql初始化脚本
┣ 📂OpenAuth.Repository //数据库访问相关代码
┣ 📂OpenAuth.App //应用逻辑代码
┣ 📂OpenAuth.Identity //IdentityServer4服务器提供OAuth服务
┣ 📂OpenAuth.Mvc //开源版Web站点已弃用⚠
┣ 📂OpenAuth.Repository //数据库访问相关代码
┣ 📂OpenAuth.WebApi //WebApi接口站点
┣ 📂sql server 初始化脚本
┣ 📂Vue2 //开源Vue2前端项目
┣ 📂数据库脚本 //数据库脚本
┣ 📜.gitattributes
┣ 📜.gitignore
┣ 📜LICENSE
┣ 📜.cursorignore //cursor codebase index忽略文件
┣ 📜Dockerfile //docker文件
┣ 📜OpenAuth.Net.sln //解决方案
┗ 📜README.md
```
@ -77,6 +58,10 @@ OpenAuth.Repository -> OpenAuthDB : 仓储层进行数据库操作
@enduml
## 安装sdk
OpenAuth.Net目前默认SDK版本为.Net 9.0.100,如果需要切换到.Net其他版本请参考[切换sdk版本](http://doc.openauth.net.cn/core/changesdk/)。可以到[微软官方](https://dotnet.microsoft.com/download)下载安装。
## 初始化数据库