From 643c3e68cc90a96bed61a37f28ced7b026179689 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 30 Jun 2025 09:26:55 +0000
Subject: [PATCH] Update README.md

---
 README.md | 160 +++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 115 insertions(+), 45 deletions(-)

diff --git a/README.md b/README.md
index dcece18..36000a6 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,143 @@
-# 💖权限+可视化流程管理系统（OverallAuth2.0版本）
-OverallAuth2.0 是一个简单、易懂、功能强大的权限+可视化流程管理系统 它使用.net core8+vue3前后端分离模式搭建。
 
-# 🎁开箱即用
 
-码友可以放心大胆的使用😄，本项目的前后端，都是作者从0到1完全独立搭建。
+💖权限+可视化流程管理系统（OverallAuth2.0版本）
+🎁开箱即用的权限管理系统
+⏳当前状态：OverallAuth2.0 持续开发中 | OverallAuth1.0 已完成
 
- **如果你不想花时间写一套权限系统，那么就下载使用吧💘💖** 
+---
 
-说明：数据库文件在qq群：801913255，因为更新频繁，就不放在这里了
+## 🏛️ 系统简介
+本项目是一个基于.NET 6的权限管理系统，提供全面的权限控制和可视化流程配置功能。系统支持菜单权限、按钮权限、数据权限（行/列）、以及角色与用户的绑定管理。
 
-# ⏳OverallAuth2.0 （持续开发中）
-预览地址：http://139.155.137.144:8881/
+---
 
-前端下载地址：https://gitee.com/yangguangchenjie/overall-auth2.0-vue
+## 🧩 核心功能
 
-后端下载地址：https://gitee.com/yangguangchenjie/overall-auth2.0-web-api
+### 🔐 权限模块
+- **菜单权限**：支持多级菜单树结构管理
+- **按钮权限**：精细化控制按钮级别的访问权限
+- **数据权限**：
+  - 行权限：通过规则引擎实现数据行级控制
+  - 列权限：控制用户可见字段
+- **数据按钮权限**：结合行/列权限实现数据感知按钮控制
 
+### 📊 可视化配置
+- 表单设计器（版本1已实现）
+- 流程引擎（版本1已实现）
+- 规则配置模块：支持SQL规则表达式生成
 
-# ⛪OverallAuth1.0 （完成）
-前端下载地址：https://gitee.com/yangguangchenjie/overall-auth.-open.-web-api
+---
 
-后端下载地址：https://gitee.com/yangguangchenjie/overall-auth.-open.-vue
+## 🧰 技术栈
 
-文档（预览）地址：http://139.155.137.144:9012
+- **框架**：.NET 6 Web API
+- **权限**：JWT、Swagger、Autofac
+- **ORM**：Dapper（通过BaseSqlRepository实现）
+- **日志**：支持登录日志与异常日志记录
+- **工具类**：Json处理、事务控制、枚举描述获取
 
-# 🚧核心权限
-## 🏢菜单权限(已实现)
-菜单权限是建立在【角色】的基础上。
-如图↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E5%BC%A0%E4%B8%89%E7%9A%84%E8%A7%92%E8%89%B2.png)
+---
 
-那么我们可以通过设置【超级管理员】这个角色来控制张三的菜单模块权限↓
+## 📁 项目结构
 
-![输入图片说明](OverallAuth-WebApi/Properties/%E8%8F%9C%E5%8D%95%E6%9D%83%E9%99%90%E5%88%86%E9%85%8D.gif)
+- **CoreDomain**：核心权限计算逻辑
+- **DomainService**：业务逻辑与接口定义
+- **Infrastructure**：数据库访问层与仓储模式
+- **Model**：实体模型与数据传输对象（DTO）
+- **OverallAuth-WebApi**：API控制器与系统插件（JWT、跨域、AOP等）
+- **Utility**：公共工具类与异常处理
 
-## 🚥按钮权限(已实现)
+---
 
-和菜单权限一样，按钮权限是建立在【角色】的基础上。
+## 🚀 快速开始
 
-说明：这里的按钮，不包括数据中的操作按钮↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%8C%89%E9%92%AE%E6%9D%83%E9%99%90.png)
+### 安装依赖
+```bash
+dotnet restore
+```
 
-那么我们可以通过设置【超级管理员】这个角色来控制张三的按钮权限↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%8C%89%E9%92%AE%E6%9D%83%E9%99%90%E5%88%86%E9%85%8D.gif)
+### 构建项目
+```bash
+dotnet build
+```
 
-## 🌈数据按钮权限(已实现)
-可以通过设置数据规则，并通过分析规则来识别数据是否满足规则条件，从而划分数据是否拥有权限。
+### 运行项目
+```bash
+dotnet run --project OverallAuth-WebApi
+```
 
-如下图↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%95%B0%E6%8D%AE%E6%8C%89%E9%92%AE%E8%A7%84%E5%88%99.png)
+---
 
-## 🌴数据行权限(已实现)
+## 📦 API 示例
 
-如下图↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%95%B0%E6%8D%AE%E8%A1%8C%E6%9D%83%E9%99%90.png)
+### 用户登录
+```csharp
+[HttpPost]
+[AllowAnonymous]
+public ReceiveStatus<LoginOutPut> Login(LoginInput loginModel)
+```
 
-## 🎨数据列权限(已实现)
+### 获取菜单树
+```csharp
+[HttpGet]
+public ReceiveStatus<SysMenuOutPut> GetMenuTreeList()
+```
 
-如下图↓
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%95%B0%E6%8D%AE%E5%88%97%E6%9D%83%E9%99%90.png)
+### 配置数据规则
+```csharp
+[HttpPost]
+public ReceiveStatus Insert(SysDataRuleInput sysDataRule)
+```
 
-# 📝可视化表单（开发中...版本1已实现）
+### 按钮权限校验
+```csharp
+public Task<bool> IsHaveButtonAuth(LoginMatchModel model, string ruleStr)
+```
 
-# 🔀可视流程设计（开发中...版本1已实现）
+---
 
-# 公众号
-关注我：每周更新该系列博客文章（从0到1搭建系统）
-![输入图片说明](OverallAuth-WebApi/Properties/%E6%89%AB%E7%A0%81_%E6%90%9C%E7%B4%A2%E8%81%94%E5%90%88%E4%BC%A0%E6%92%AD%E6%A0%B7%E5%BC%8F-%E6%A0%87%E5%87%86%E8%89%B2%E7%89%88.png)
-关注我：一个全栈多端的宝藏博主，定时分享技术文章，不定时分享开源项目。关注我，带你认识不一样的程序世界
+## 🧑‍💻 用户角色管理
 
-# 🙏🙏🙏求star
-开源不易，star支持
\ No newline at end of file
+- 支持角色继承与子级角色
+- 可配置角色所属菜单与按钮权限
+- 支持角色与用户的绑定操作
+
+---
+
+## 📎 数据列控制
+
+- 通过`SysMenuTableCols`实现字段级别的显示控制
+- 支持列排序、固定、对齐等前端配置
+- 可同步数据库字段到权限系统
+
+---
+
+## 📚 日志与审计
+
+- 登录日志：记录用户登录IP、地理位置
+- 异常日志：全局异常捕获与记录
+- 数据变更日志：通过仓储层记录操作轨迹
+
+---
+
+## 🧪 单元测试与验证
+- 所有业务逻辑均通过`ReceiveStatus`返回统一结果
+- 使用`Validate`方法进行数据校验
+- 支持测试环境与生产环境配置分离
+
+---
+
+## 📄 许可协议
+本项目遵循 MIT 许可协议，源码可免费用于商业和非商业用途。
+
+---
+
+## 📢 公众号与社区
+- 微信公众号：OverallAuth（搜索关注获取最新动态）
+- 社区：欢迎提交PR与Issue
+
+---
+
+## ⭐ 求Star支持
+如果您喜欢这个项目，请给予Star支持，您的鼓励是我们前进的动力！
+🙏🙏🙏 感谢所有贡献者与支持者！
\ No newline at end of file
-- 
Gitee