diff --git a/README.md b/README.md index 401d9cec50eaedf498cc67424d9d732dfbb56eac..069fd18f6749b5b87cda8d69fe5265b2c7b70a30 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,67 @@ -# GodOxModulesShell +# GodOxModulesShell
- 如果对您有帮助，点击右上角⭐Star⭐关注 ，感谢支持开源！
+## 介绍 -#### 介绍 +这是一个基于 **.NET Core** 开发的模块化业务框架，核心思想借鉴了 **ABP VNext**，支持依赖注入，轻量级，适用于中小型项目的模块化开发。框架实现了业务模块的 **CRUD API** 接口抽象到上层 Controller，只需建立对应的实体，即可生成某张表的增删改查接口，未来将往低代码方向发展。 - **基于dotNetCore基础之上开发的模块化业务框架。核心思想借鉴了ABP VNext,支持依赖注入，轻量级，适用于中小项目模块化。业务模块CRUD API接口抽象到上层controller,只需要建立对应的实体，即可生成某张表的增删改查接口，未来将往低代码的方向发展** - - 所有的代码坚持" **Don't repeat yourself** "。坚决反对" **简单的事情复杂干** "，" **大量代码在应用层过度层层封装** "，反对" **过度设计** "的原则下进行开发。 +所有代码遵循 **"Don't repeat yourself"** 原则，坚决反对 **"简单的事情复杂干"**、**"大量代码在应用层过度封装"** 和 **"过度设计"** 的开发方式。 - 如果你有这个习惯，并且也想找一款迷你型、上手快，不用学习太多东西的框架，那么它就适合你，只要你会dotnet core,几乎没有学习成本。 +如果你希望使用一个 **迷你型、上手快、学习成本低** 的框架，那么这个框架非常适合你。只要你熟悉 **.NET Core**，几乎不需要额外学习。 +## 单机架构 - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PackageNuGetDownloads
ShenNius.Caches ShenNius.Caches
ShenNius.FileManagement ShenNius.Caches
ShenNius.ModuleCore ShenNius.Caches
ShenNius.Repository ShenNius.Caches
- - -#### 单机架构 +该项目还有一个单体架构版本：[适合小白入门进阶，更适用(实用)老手上路干活的dotnetcore框架](https://gitee.com/shenniu_code_group/shen-nius.-modularity) - **该项目还有个单体架构地址：[适合小白入门进阶，更适用(实用)老手上路干活的dotnetcore框架](https://gitee.com/shenniu_code_group/shen-nius.-modularity)** +## 特别申明 -#### 特别申明 +注意：**该项目新功能的迭代今后我会放在模块化分支上，单体架构的新功能可能会在最新的 ASP.NET Core 版本上开发。老版本的新功能将提供有偿服务！** - 注意：**该项目新功能的迭代今后我会放在模块化分支上面，单体新功能的迭代一般可能会在最新的asp.netcore版本上开发。老版本新功能有偿服务！** +## 软件架构 -#### 软件架构 +框架主要由以下几部分组成： -主要是使用已经千锤百炼的组件进行积木组装，然后结合业务快速开发，配合顺手的ORM，不管开发API还是mvc效率和性能都是杠杠的。 +1. **framework 文件夹**：模块化核心代码和常用组件。 +2. **module 文件夹**：包含后台管理和小程序的 API 接口。 +3. **client 文件夹**：各业务的宿主项目。 -1. framework文件夹下分别是模块化的核心代码和常用组件。 +## 使用技术 -2. module 文件夹有后台管理和小程序的API接口。 +- **API 框架**：.NET Core +- **ORM**：SqlSugarCore +- **缓存**：MemoryCache 和 Redis 可一键切换 +- **日志管理**：NLog +- **工具类**：Aes 加密、Md5 加密、RSA 加密、Des 加密 +- **Token**：JWT（Json Web Token） +- **实体验证**：FluentValidation +- **实体映射**：AutoMapper +- **数据库**：MySQL（后续支持 SQL Server :// +- **跨平台部署**：支持 Linux / Windows +- **AOP 缓存**：使用 AspectCore，缓存可一键切换为 MemoryCache 或 Redis +- **AOP 事务**：服务层和控制器均可通过特性标签使用 +- **多租户**：通过 Filter 实现自动赋值（添加、更新、查询） +- **图片上传**：支持七牛云和本地上传一键切换 +- **单表 CRUD**：控制器封装了通用接口，只需按约定建立实体即可生成对应 API -3. client分别为各业务的宿主。 +## 安装教程 -#### 使用技术 +1. 克隆项目： + ```bash + git clone -b master https://gitee.com/shenniu_code_group/godox-modulesshell + ``` -1. API框架：dotNetCore -2. ORM：SqlSugarCore -3. 缓存：MemoryCache和redis一键任意切换 -4. 日志管理：Nlog -5. 工具类：Aes加密、Md5加密、RSA加密、Des加密 -6. token:Json Web Token -7. 实体验证：FluentValidation -8. 实体映射：AutoMapper -9. 数据库使用mysql（后面会做sqlserver等其他数据库的兼容） -10. 支持跨平台部署 linux/windows -11. 支持AOP缓存，使用AspectCore,缓存可做到Memarycache和redis一键切换 -12. 支持AOP事务，服务层和控制器都可以打上特性标签使用 -13. 对多租户使用Filter，不管是添加还是更新、查询即可自动赋值 -14. 支持七牛云和本地图片一键切换使用上传 -15. 对于单表的增删改查，在控制器内做了封装，有新的业务按约定建立对应的CRUD实体，一套API自动完成 +2. 在 MySQL 上创建数据库，并执行 `doc` 文件夹下的 SQL 脚本（以最近日期为准），该文件夹还包含数据库字典文档（Word、CHM、HTML 格式）。 +3. 配置启动信息： + - `Godox.Mvc.Admin`（前后端不分离）和 `Godox.API.Hosting`（前后端分离 API）项目中的 `appsettings.json` 文件。 -#### 安装教程 +4. 如在使用过程中遇到问题，欢迎提交 Issues，我会第一时间响应。 -1. git clone -b master https://gitee.com/shenniu_code_group/godox-modulesshell -2. 在mysql上创建数据库，然后执行源码doc文件夹下的sql脚本语句，以最近日期为准。doc文件夹里面数据库字典文档，word、CHM、html格式的都有。 -3. GodOx.Mvc.Admin（前后端不分离）和GodOx.API.Hosting（前后端分离 API）可以配置你要启动的appsettings.json文件信息。 -4、 使用过程中有什么问题欢迎提issues,基本都会第一时间解决。 +## 案例效果图 - -#### 案例效果图 - - #### 权限管理模块 +### 权限管理模块 @@ -103,55 +72,54 @@ - - - - + + + - - - - - - + +
- #### CMS系统模块 - - - +### CMS 系统模块 + +
+ + - - - + + + - +
- #### 商城系统模块 - - - +### 商城系统模块 + +
+ + - - - + + +
-#### 入群交流 -QQ群：dotnet根据地878303823 +## 入群交流 +QQ 群：dotnet根据地878303823 +## 参与贡献 -#### 参与贡献 +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 许可证 +本项目采用 MIT 许可证。详情请查看项目根目录下的 `LICENSE` 文件。 \ No newline at end of file