diff --git a/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.EN.md new file mode 100644 index 000000000..aed3f086f --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.EN.md @@ -0,0 +1,80 @@ +# LINGYUN.Abp.UI.Navigation.VueVbenAdmin + +Navigation menu initialization module for **abp-vue-vben-admin**. This module provides menu data initialization functionality required for integration with the VueVbenAdmin frontend framework. + +## Features + +* Menu Data Initialization + * Preset menu structure + * Automatic layout registration + * Dynamic menu configuration + +* VueVbenAdmin Integration + * Layout component configuration + * UI theme adaptation + * Menu item customization + +* Extensibility Support + * Custom menu providers + * Menu data override + * Layout configuration extensions + +## Quick Start + +1. Reference the module +```csharp +[DependsOn(typeof(AbpUINavigationVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +2. Configure options +```csharp +Configure(options => +{ + // UI name configuration + options.UI = "Vue Vben Admin"; + // Layout name configuration + options.LayoutName = "Vben Admin Layout"; + // Layout component configuration + options.LayoutPath = "LAYOUT"; +}); +``` + +## Configuration Options + +* `AbpUINavigationVueVbenAdminOptions.UI` + * Description: UI name + * Default value: Vue Vben Admin + * Note: Not recommended to change, must be consistent with frontend + +* `AbpUINavigationVueVbenAdminOptions.LayoutName` + * Description: Layout name + * Default value: Vben Admin Layout + * Note: Not recommended to change, must be consistent with frontend + +* `AbpUINavigationVueVbenAdminOptions.LayoutPath` + * Description: Layout component path + * Default value: LAYOUT + * Note: Not recommended to change, must be consistent with frontend + +## Usage Guide + +1. Menu Initialization + * The module automatically registers default menu data + * Custom menus can be added by implementing the `INavigationDataSeedContributor` interface + +2. Layout Configuration + * Layout configuration must match the frontend route configuration + * When modifying layout configuration, related frontend configurations need to be synchronized + +3. Extension Development + * Custom menu initialization logic can be implemented by inheriting the `VueVbenAdminNavigationDataSeeder` class + * Default implementations can be overridden through dependency injection + +## More Information + +* [VueVbenAdmin Official Documentation](https://doc.vvbin.cn/) +* [ABP Official Documentation](https://docs.abp.io/) diff --git a/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.md b/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.md index 699aca2dc..34db9927b 100644 --- a/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.md +++ b/aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/README.md @@ -1,21 +1,80 @@ -# LINGYUN.Abp.UI.Navigation.VueVbenAdmin - -适用于 **abp-vue-vben-admin** 的初始化菜单数据模块 - -## 配置使用 - -```csharp -[DependsOn(typeof(AbpUINavigationVueVbenAdminModule))] -public class YouProjectModule : AbpModule -{ - // other -} -``` - -## 配置项 - -* AbpUINavigationVueVbenAdminOptions.UI UI名称,默认值: Vue Vben Admin,不建议变更,否则需要改变前端 -* AbpUINavigationVueVbenAdminOptions.LayoutName 布局名称,默认值: Vben Admin Layout,不建议变更,否则需要改变前端 -* AbpUINavigationVueVbenAdminOptions.LayoutPath 布局组件,默认值: LAYOUT,不建议变更,否则需要改变前端 - -## 其他 +# LINGYUN.Abp.UI.Navigation.VueVbenAdmin + +适用于 **abp-vue-vben-admin** 的导航菜单初始化模块。本模块提供了与VueVbenAdmin前端框架集成所需的菜单数据初始化功能。 + +## 功能特性 + +* 菜单数据初始化 + * 预设菜单结构 + * 自动注册布局 + * 动态菜单配置 + +* VueVbenAdmin集成 + * 布局组件配置 + * UI主题适配 + * 菜单项定制 + +* 扩展性支持 + * 自定义菜单提供者 + * 菜单数据重写 + * 布局配置扩展 + +## 快速开始 + +1. 引用模块 +```csharp +[DependsOn(typeof(AbpUINavigationVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +2. 配置选项 +```csharp +Configure(options => +{ + // UI名称配置 + options.UI = "Vue Vben Admin"; + // 布局名称配置 + options.LayoutName = "Vben Admin Layout"; + // 布局组件配置 + options.LayoutPath = "LAYOUT"; +}); +``` + +## 配置项说明 + +* `AbpUINavigationVueVbenAdminOptions.UI` + * 说明:UI名称 + * 默认值:Vue Vben Admin + * 注意:不建议变更,需要与前端保持一致 + +* `AbpUINavigationVueVbenAdminOptions.LayoutName` + * 说明:布局名称 + * 默认值:Vben Admin Layout + * 注意:不建议变更,需要与前端保持一致 + +* `AbpUINavigationVueVbenAdminOptions.LayoutPath` + * 说明:布局组件路径 + * 默认值:LAYOUT + * 注意:不建议变更,需要与前端保持一致 + +## 使用说明 + +1. 菜单初始化 + * 模块会自动注册默认的菜单数据 + * 可以通过实现 `INavigationDataSeedContributor` 接口来添加自定义菜单 + +2. 布局配置 + * 布局配置需要与前端的路由配置相匹配 + * 修改布局配置时需要同步修改前端相关配置 + +3. 扩展开发 + * 可以通过继承 `VueVbenAdminNavigationDataSeeder` 类来自定义菜单初始化逻辑 + * 支持通过依赖注入覆盖默认实现 + +## 更多信息 + +* [VueVbenAdmin官方文档](https://doc.vvbin.cn/) +* [ABP官方文档](https://docs.abp.io/) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.EN.md new file mode 100644 index 000000000..a17382dcd --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.EN.md @@ -0,0 +1,85 @@ +# LINGYUN.Platform.Application.Contracts + +The application service contract layer of the platform management module, defining application service interfaces, DTO objects, and permission definitions. + +## Features + +* Menu Management Interface + * Menu CRUD operations + * User menu management + * Role menu management + * Menu favorite functionality + +* Package Management Interface + * Package CRUD operations + * Package version management + * Package file upload and download + +* Permission Definitions + * Platform management permission group + * Data dictionary permissions + * Menu management permissions + * Package management permissions + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformApplicationContractsModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Application Service Interfaces + +* `IMenuAppService`: Menu management service interface +* `IUserFavoriteMenuAppService`: User favorite menu service interface +* `IPackageAppService`: Package management service interface + +## Data Transfer Objects + +* Menu Related DTOs + * `MenuDto`: Menu DTO + * `MenuCreateDto`: Create menu DTO + * `MenuUpdateDto`: Update menu DTO + * `MenuItemDto`: Menu item DTO + * `UserFavoriteMenuDto`: User favorite menu DTO + +* Package Management Related DTOs + * `PackageDto`: Package DTO + * `PackageCreateDto`: Create package DTO + * `PackageUpdateDto`: Update package DTO + * `PackageBlobDto`: Package file DTO + +## Permission Definitions + +```json +{ + "Platform": { + "Default": "Platform Management", + "DataDictionary": { + "Default": "Data Dictionary Management", + "Create": "Create", + "Update": "Update", + "Delete": "Delete" + }, + "Menu": { + "Default": "Menu Management", + "Create": "Create", + "Update": "Update", + "Delete": "Delete" + }, + "Package": { + "Default": "Package Management", + "Create": "Create", + "Update": "Update", + "Delete": "Delete" + } + } +} +``` + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.md new file mode 100644 index 000000000..ff2484f84 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Application.Contracts/README.md @@ -0,0 +1,85 @@ +# LINGYUN.Platform.Application.Contracts + +平台管理模块的应用服务契约层,定义了应用服务接口、DTO对象和权限定义。 + +## 功能特性 + +* 菜单管理接口 + * 菜单CRUD操作 + * 用户菜单管理 + * 角色菜单管理 + * 菜单收藏功能 + +* 包管理接口 + * 包CRUD操作 + * 包版本管理 + * 包文件上传下载 + +* 权限定义 + * 平台管理权限组 + * 数据字典权限 + * 菜单管理权限 + * 包管理权限 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformApplicationContractsModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 应用服务接口 + +* `IMenuAppService`: 菜单管理服务接口 +* `IUserFavoriteMenuAppService`: 用户收藏菜单服务接口 +* `IPackageAppService`: 包管理服务接口 + +## 数据传输对象 + +* 菜单相关DTO + * `MenuDto`: 菜单DTO + * `MenuCreateDto`: 创建菜单DTO + * `MenuUpdateDto`: 更新菜单DTO + * `MenuItemDto`: 菜单项DTO + * `UserFavoriteMenuDto`: 用户收藏菜单DTO + +* 包管理相关DTO + * `PackageDto`: 包DTO + * `PackageCreateDto`: 创建包DTO + * `PackageUpdateDto`: 更新包DTO + * `PackageBlobDto`: 包文件DTO + +## 权限定义 + +```json +{ + "Platform": { + "Default": "平台管理", + "DataDictionary": { + "Default": "数据字典管理", + "Create": "创建", + "Update": "更新", + "Delete": "删除" + }, + "Menu": { + "Default": "菜单管理", + "Create": "创建", + "Update": "更新", + "Delete": "删除" + }, + "Package": { + "Default": "包管理", + "Create": "创建", + "Update": "更新", + "Delete": "删除" + } + } +} +``` + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.EN.md new file mode 100644 index 000000000..39eb9bc87 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.EN.md @@ -0,0 +1,69 @@ +# LINGYUN.Platform.Application + +The application service implementation layer of the platform management module, implementing all functionality defined in the application service interfaces. + +## Features + +* User Favorite Menu Service + * Create favorite menu + * Update favorite menu + * Delete favorite menu + * Query favorite menu list + * Manage other users' favorite menus + +* Object Mapping Configuration + * Automatic mapping from entities to DTOs + * Support for custom mapping rules + * Support for extra property mapping + +* Permission Validation + * Policy-based permission validation + * Integration with ABP authorization system + * Fine-grained permission control + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformApplicationModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Application Service Implementation + +* `UserFavoriteMenuAppService`: User favorite menu service implementation + * Support for custom menu icons + * Support for custom menu colors + * Support for custom menu aliases + * Support for multi-framework menu management + +## Object Mapping + +```csharp +public class PlatformApplicationMappingProfile : Profile +{ + public PlatformApplicationMappingProfile() + { + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + } +} +``` + +## Base Services + +* `PlatformApplicationServiceBase`: Platform management application service base class + * Provides common functionality and helper methods + * Unified exception handling + * Unified permission validation + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.md new file mode 100644 index 000000000..f10ea3014 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Application/README.md @@ -0,0 +1,69 @@ +# LINGYUN.Platform.Application + +平台管理模块的应用服务实现层,实现了应用服务接口定义的所有功能。 + +## 功能特性 + +* 用户收藏菜单服务 + * 创建收藏菜单 + * 更新收藏菜单 + * 删除收藏菜单 + * 查询收藏菜单列表 + * 管理其他用户的收藏菜单 + +* 对象映射配置 + * 实体到DTO的自动映射 + * 支持自定义映射规则 + * 支持额外属性映射 + +* 权限验证 + * 基于策略的权限验证 + * 集成ABP授权系统 + * 细粒度的权限控制 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformApplicationModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 应用服务实现 + +* `UserFavoriteMenuAppService`: 用户收藏菜单服务实现 + * 支持用户自定义菜单图标 + * 支持用户自定义菜单颜色 + * 支持用户自定义菜单别名 + * 支持多框架菜单管理 + +## 对象映射 + +```csharp +public class PlatformApplicationMappingProfile : Profile +{ + public PlatformApplicationMappingProfile() + { + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + CreateMap(); + } +} +``` + +## 基础服务 + +* `PlatformApplicationServiceBase`: 平台管理应用服务基类 + * 提供通用功能和帮助方法 + * 统一异常处理 + * 统一权限验证 + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.EN.md new file mode 100644 index 000000000..66f4a7d33 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.EN.md @@ -0,0 +1,30 @@ +# LINGYUN.Platform.Domain.Shared + +The shared domain layer of the platform management module, which defines the basic types, enumerations, and constants required for platform management. + +## Features + +* Define platform management basic enumerations +* Define platform management constants +* Define platform management localization resources +* Define platform management domain shared interfaces + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformDomainSharedModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Basic Usage + +1. Reference the module +2. Use defined enumerations and constants +3. Use localization resources + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.md new file mode 100644 index 000000000..52586019f --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/README.md @@ -0,0 +1,30 @@ +# LINGYUN.Platform.Domain.Shared + +平台管理模块的共享领域层,定义了平台管理所需的基本类型、枚举和常量。 + +## 功能特性 + +* 定义平台管理基础枚举 +* 定义平台管理常量 +* 定义平台管理本地化资源 +* 定义平台管理领域共享接口 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformDomainSharedModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 基本用法 + +1. 引用模块 +2. 使用定义的枚举和常量 +3. 使用本地化资源 + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.EN.md new file mode 100644 index 000000000..f97929b04 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.EN.md @@ -0,0 +1,69 @@ +# LINGYUN.Platform.Domain + +The domain layer of the platform management module, implementing core business logic and domain models required for platform management. + +## Features + +* Menu Management + * Support for multi-level menu structure + * User menu customization + * Role menu permissions + * Menu standardization conversion + +* Layout Management + * Layout view entities + * Layout data association + * Multi-framework support + +* Data Dictionary + * Data dictionary management + * Data dictionary item management + * Data dictionary seed data + +* Package Management + * Package version control + * Package file management + * Blob storage integration + * Package filtering specification + +* Enterprise Portal + * Enterprise information management + * Enterprise data storage + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformDomainModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Domain Services + +* `DataDictionaryDataSeeder`: Data dictionary seed data service +* `PackageBlobManager`: Package file management service +* `DefaultStandardMenuConverter`: Standard menu conversion service + +## Repository Interfaces + +* `IMenuRepository`: Menu repository interface +* `IUserMenuRepository`: User menu repository interface +* `IRoleMenuRepository`: Role menu repository interface +* `ILayoutRepository`: Layout repository interface +* `IEnterpriseRepository`: Enterprise repository interface + +## Entities + +* `Menu`: Menu entity +* `UserMenu`: User menu entity +* `RoleMenu`: Role menu entity +* `Layout`: Layout entity +* `Package`: Package entity +* `Data`: Data dictionary entity +* `DataItem`: Data dictionary item entity + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.md new file mode 100644 index 000000000..33fe568fe --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Domain/README.md @@ -0,0 +1,69 @@ +# LINGYUN.Platform.Domain + +平台管理模块的领域层,实现了平台管理所需的核心业务逻辑和领域模型。 + +## 功能特性 + +* 菜单管理 + * 支持多级菜单结构 + * 用户菜单定制 + * 角色菜单权限 + * 菜单标准化转换 + +* 布局管理 + * 布局视图实体 + * 布局数据关联 + * 多框架支持 + +* 数据字典 + * 数据字典管理 + * 数据字典项管理 + * 数据字典种子数据 + +* 包管理 + * 包版本控制 + * 包文件管理 + * Blob存储集成 + * 包过滤规范 + +* 企业门户 + * 企业信息管理 + * 企业数据存储 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformDomainModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 领域服务 + +* `DataDictionaryDataSeeder`: 数据字典种子数据服务 +* `PackageBlobManager`: 包文件管理服务 +* `DefaultStandardMenuConverter`: 标准菜单转换服务 + +## 仓储接口 + +* `IMenuRepository`: 菜单仓储接口 +* `IUserMenuRepository`: 用户菜单仓储接口 +* `IRoleMenuRepository`: 角色菜单仓储接口 +* `ILayoutRepository`: 布局仓储接口 +* `IEnterpriseRepository`: 企业仓储接口 + +## 实体 + +* `Menu`: 菜单实体 +* `UserMenu`: 用户菜单实体 +* `RoleMenu`: 角色菜单实体 +* `Layout`: 布局实体 +* `Package`: 包实体 +* `Data`: 数据字典实体 +* `DataItem`: 数据字典项实体 + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.EN.md new file mode 100644 index 000000000..286e3ffba --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.EN.md @@ -0,0 +1,57 @@ +# LINGYUN.Platform.EntityFrameworkCore + +The EntityFrameworkCore implementation of the platform management module, providing data access and persistence functionality. + +## Features + +* Implementation of all platform management repository interfaces +* Support for multiple database providers +* Entity relationship mapping configuration +* Database context definition +* Support for query optimization and performance tuning + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformEntityFrameworkCoreModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Repository Implementations + +* `EfCoreUserMenuRepository`: User menu repository implementation + * Support for getting user startup menu + * Support for user menu list query + * Support for user menu permission validation + +* `EfCorePackageRepository`: Package management repository implementation + * Support for package version query + * Support for package specification filtering + * Support for package details loading + +* `EfCoreEnterpriseRepository`: Enterprise repository implementation + * Support for tenant association query + * Support for enterprise list pagination + +## Database Context + +* `IPlatformDbContext`: Platform management database context interface + * Define DbSet for all entities + * Support for multi-tenant data isolation + +## Configuration + +```json +{ + "ConnectionStrings": { + "Platform": "Server=localhost;Database=Platform;Trusted_Connection=True" + } +} +``` + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.md new file mode 100644 index 000000000..a7e9b1869 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.EntityFrameworkCore/README.md @@ -0,0 +1,57 @@ +# LINGYUN.Platform.EntityFrameworkCore + +平台管理模块的EntityFrameworkCore实现,提供了数据访问和持久化功能。 + +## 功能特性 + +* 实现平台管理所有仓储接口 +* 支持多数据库提供程序 +* 实体关系映射配置 +* 数据库上下文定义 +* 支持查询优化和性能调优 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformEntityFrameworkCoreModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 仓储实现 + +* `EfCoreUserMenuRepository`: 用户菜单仓储实现 + * 支持获取用户启动菜单 + * 支持用户菜单列表查询 + * 支持用户菜单权限验证 + +* `EfCorePackageRepository`: 包管理仓储实现 + * 支持包版本查询 + * 支持包规格过滤 + * 支持包详情加载 + +* `EfCoreEnterpriseRepository`: 企业仓储实现 + * 支持租户关联查询 + * 支持企业列表分页 + +## 数据库上下文 + +* `IPlatformDbContext`: 平台管理数据库上下文接口 + * 定义所有实体的DbSet + * 支持多租户数据隔离 + +## 配置项 + +```json +{ + "ConnectionStrings": { + "Platform": "Server=localhost;Database=Platform;Trusted_Connection=True" + } +} +``` + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.EN.md new file mode 100644 index 000000000..f782eea5b --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.EN.md @@ -0,0 +1,71 @@ +# LINGYUN.Platform.HttpApi + +The HTTP API layer of the platform management module, providing RESTful style API interfaces. + +## Features + +* Menu Management API + * Get current user menu + * Get user menu list + * Get role menu list + * Menu CRUD operations + * User favorite menu management + +* Layout Management API + * Layout CRUD operations + * Get all layouts list + +* Data Dictionary API + * Data dictionary CRUD operations + * Data dictionary item management + +* Package Management API + * Package CRUD operations + * Package file upload and download + * Get latest version package + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformHttpApiModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## API Controllers + +* `MenuController`: Menu management controller + * `GET /api/platform/menus/by-current-user`: Get current user menu + * `GET /api/platform/menus/by-user`: Get specified user menu + * `GET /api/platform/menus/by-role`: Get role menu + * `POST /api/platform/menus`: Create menu + * `PUT /api/platform/menus/{id}`: Update menu + * `DELETE /api/platform/menus/{id}`: Delete menu + +* `UserFavoriteMenuController`: User favorite menu controller + * `GET /api/platform/menus/favorites/my-favorite-menus`: Get my favorite menus + * `POST /api/platform/menus/favorites/my-favorite-menus`: Create favorite menu + * `PUT /api/platform/menus/favorites/my-favorite-menus/{MenuId}`: Update favorite menu + * `DELETE /api/platform/menus/favorites/my-favorite-menus`: Delete favorite menu + +* `PackageController`: Package management controller + * `GET /api/platform/packages/{Name}/latest`: Get latest version package + * `POST /api/platform/packages/{id}/blob`: Upload package file + * `GET /api/platform/packages/{id}/blob/{Name}`: Download package file + * `DELETE /api/platform/packages/{id}/blob/{Name}`: Delete package file + +## Configuration + +```json +{ + "App": { + "CorsOrigins": "https://*.YourDomain.com,http://localhost:4200" + } +} +``` + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.md new file mode 100644 index 000000000..806b3bdf4 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.HttpApi/README.md @@ -0,0 +1,71 @@ +# LINGYUN.Platform.HttpApi + +平台管理模块的HTTP API层,提供了RESTful风格的API接口。 + +## 功能特性 + +* 菜单管理API + * 获取当前用户菜单 + * 获取用户菜单列表 + * 获取角色菜单列表 + * 菜单CRUD操作 + * 用户收藏菜单管理 + +* 布局管理API + * 布局CRUD操作 + * 获取所有布局列表 + +* 数据字典API + * 数据字典CRUD操作 + * 数据字典项管理 + +* 包管理API + * 包CRUD操作 + * 包文件上传下载 + * 获取最新版本包 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformHttpApiModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## API控制器 + +* `MenuController`: 菜单管理控制器 + * `GET /api/platform/menus/by-current-user`: 获取当前用户菜单 + * `GET /api/platform/menus/by-user`: 获取指定用户菜单 + * `GET /api/platform/menus/by-role`: 获取角色菜单 + * `POST /api/platform/menus`: 创建菜单 + * `PUT /api/platform/menus/{id}`: 更新菜单 + * `DELETE /api/platform/menus/{id}`: 删除菜单 + +* `UserFavoriteMenuController`: 用户收藏菜单控制器 + * `GET /api/platform/menus/favorites/my-favorite-menus`: 获取我的收藏菜单 + * `POST /api/platform/menus/favorites/my-favorite-menus`: 创建收藏菜单 + * `PUT /api/platform/menus/favorites/my-favorite-menus/{MenuId}`: 更新收藏菜单 + * `DELETE /api/platform/menus/favorites/my-favorite-menus`: 删除收藏菜单 + +* `PackageController`: 包管理控制器 + * `GET /api/platform/packages/{Name}/latest`: 获取最新版本包 + * `POST /api/platform/packages/{id}/blob`: 上传包文件 + * `GET /api/platform/packages/{id}/blob/{Name}`: 下载包文件 + * `DELETE /api/platform/packages/{id}/blob/{Name}`: 删除包文件 + +## 配置项 + +```json +{ + "App": { + "CorsOrigins": "https://*.YourDomain.com,http://localhost:4200" + } +} +``` + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.EN.md new file mode 100644 index 000000000..4622d24d1 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.EN.md @@ -0,0 +1,87 @@ +# LINGYUN.Platform.Settings.VueVbenAdmin + +The platform settings module for the VueVbenAdmin frontend framework, providing theme, layout, menu, and other setting features. + +## Features + +* Theme Settings + * Dark mode + * Gray mode + * Color weak mode + * Theme color + +* Layout Settings + * Full screen mode + * Content mode + * Page loading state + * Footer display + * Back to top + +* Menu Settings + * Menu mode + * Menu theme + * Menu width + * Menu collapse + * Menu split + * Menu drag + +* Header Settings + * Fixed header + * Header theme + * Full screen button + * Document button + * Notice button + * Search button + +* Multi-tab Settings + * Tab cache + * Tab drag + * Tab refresh + * Tab fold + +## Module Reference + +```csharp +[DependsOn(typeof(PlatformSettingsVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Localization Resources + +* Support for Simplified Chinese +* Support for English + +## Configuration + +```json +{ + "Settings": { + "DarkMode": false, + "PageLoading": true, + "PermissionCacheType": 1, + "ShowSettingButton": true, + "ShowDarkModeToggle": true, + "SettingButtonPosition": "auto", + "PermissionMode": "ROUTE_MAPPING", + "SessionTimeoutProcessing": 0, + "GrayMode": false, + "ColorWeak": false, + "ThemeColor": "#0960bd", + "FullContent": false, + "ContentMode": "full", + "ShowLogo": true, + "ShowFooter": true, + "OpenKeepAlive": true, + "LockTime": 0, + "ShowBreadCrumb": true, + "ShowBreadCrumbIcon": false + } +} +``` + +## More + +For more information, please refer to [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.md new file mode 100644 index 000000000..58827b858 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/README.md @@ -0,0 +1,87 @@ +# LINGYUN.Platform.Settings.VueVbenAdmin + +VueVbenAdmin前端框架的平台设置模块,提供了主题、布局、菜单等设置功能。 + +## 功能特性 + +* 主题设置 + * 暗黑模式 + * 灰色模式 + * 色弱模式 + * 主题颜色 + +* 布局设置 + * 全屏模式 + * 内容模式 + * 页面加载状态 + * 页脚显示 + * 返回顶部 + +* 菜单设置 + * 菜单模式 + * 菜单主题 + * 菜单宽度 + * 菜单折叠 + * 菜单分割 + * 菜单拖拽 + +* 标题栏设置 + * 固定标题栏 + * 标题栏主题 + * 全屏按钮 + * 文档按钮 + * 通知按钮 + * 搜索按钮 + +* 多标签页设置 + * 标签页缓存 + * 标签页拖拽 + * 标签页刷新 + * 标签页折叠 + +## 模块引用 + +```csharp +[DependsOn(typeof(PlatformSettingsVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 本地化资源 + +* 支持中文简体 +* 支持英文 + +## 配置项 + +```json +{ + "Settings": { + "DarkMode": false, + "PageLoading": true, + "PermissionCacheType": 1, + "ShowSettingButton": true, + "ShowDarkModeToggle": true, + "SettingButtonPosition": "auto", + "PermissionMode": "ROUTE_MAPPING", + "SessionTimeoutProcessing": 0, + "GrayMode": false, + "ColorWeak": false, + "ThemeColor": "#0960bd", + "FullContent": false, + "ContentMode": "full", + "ShowLogo": true, + "ShowFooter": true, + "OpenKeepAlive": true, + "LockTime": 0, + "ShowBreadCrumb": true, + "ShowBreadCrumbIcon": false + } +} +``` + +## 更多 + +更多信息请参考 [Platform](../README.md) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.EN.md b/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.EN.md new file mode 100644 index 000000000..fac26b59d --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.EN.md @@ -0,0 +1,130 @@ +# LINGYUN.Platform.Theme.VueVbenAdmin + +Theme management module for the VueVbenAdmin frontend framework, providing management functionality for theme, layout, menu, and related configurations. + +## Features + +* Theme Settings + * Dark mode + * Gray mode + * Color weak mode + * Theme color configuration + +* Layout Settings + * Full screen mode + * Content mode + * Page loading state + * Footer display + * Back to top + +* Menu Settings + * Menu mode + * Menu theme + * Menu width + * Menu collapse + * Menu split + * Menu drag + +* Header Settings + * Fixed header + * Header theme + * Full screen button + * Document button + * Notice button + * Search button + +* Multi-tab Settings + * Tab cache + * Tab drag + * Tab refresh + * Tab fold + +## Quick Start + +1. Reference the module +```csharp +[DependsOn(typeof(PlatformThemeVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +2. Configure options +```json +{ + "Theme": { + "DarkMode": false, + "GrayMode": false, + "ColorWeak": false, + "ThemeColor": "#0960bd" + }, + "Layout": { + "FullContent": false, + "ContentMode": "full", + "ShowLogo": true, + "ShowFooter": true, + "ShowBreadCrumb": true, + "ShowBreadCrumbIcon": false + }, + "Menu": { + "Mode": "inline", + "Theme": "dark", + "Width": 210, + "Collapsed": false, + "Split": false, + "Draggable": true + }, + "Header": { + "Fixed": true, + "Theme": "light", + "ShowFullScreen": true, + "ShowDoc": true, + "ShowNotice": true, + "ShowSearch": true + }, + "MultiTab": { + "Cache": true, + "Draggable": true, + "Refresh": true, + "Fold": true + } +} +``` + +## Usage Guide + +1. Theme Configuration + * Support for multiple theme mode switching + * Customizable theme colors + * Theme persistence storage + +2. Layout Configuration + * Flexible layout modes + * Configurable page element display + * Responsive layout support + +3. Menu Configuration + * Various menu display modes + * Support for menu drag sorting + * Menu theme customization + +4. Extension Development + * Support for custom theme configuration providers + * Extensible theme settings + * Theme data localization support + +## Important Notes + +1. Theme Configuration + * Theme configurations affect the interface display for all users + * Choose appropriate theme modes based on actual requirements + +2. Performance Considerations + * Configure tab cache quantity reasonably + * Use page loading animations appropriately + +## More Information + +* [VueVbenAdmin Theme Configuration Documentation](https://doc.vvbin.cn/guide/design.html) +* [ABP Official Documentation](https://docs.abp.io/) diff --git a/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.md b/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.md new file mode 100644 index 000000000..634942166 --- /dev/null +++ b/aspnet-core/modules/platform/LINGYUN.Platform.Theme.VueVbenAdmin/README.md @@ -0,0 +1,130 @@ +# LINGYUN.Platform.Theme.VueVbenAdmin + +VueVbenAdmin前端框架的主题管理模块,提供主题、布局、菜单等相关配置的管理功能。 + +## 功能特性 + +* 主题设置 + * 暗黑模式 + * 灰色模式 + * 色弱模式 + * 主题色配置 + +* 布局设置 + * 全屏模式 + * 内容模式 + * 页面加载状态 + * 页脚显示 + * 返回顶部 + +* 菜单设置 + * 菜单模式 + * 菜单主题 + * 菜单宽度 + * 菜单折叠 + * 菜单拆分 + * 菜单拖拽 + +* 标题栏设置 + * 固定头部 + * 头部主题 + * 全屏按钮 + * 文档按钮 + * 通知按钮 + * 搜索按钮 + +* 多标签页设置 + * 标签页缓存 + * 标签页拖拽 + * 标签页刷新 + * 标签页折叠 + +## 快速开始 + +1. 引用模块 +```csharp +[DependsOn(typeof(PlatformThemeVueVbenAdminModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +2. 配置选项 +```json +{ + "Theme": { + "DarkMode": false, + "GrayMode": false, + "ColorWeak": false, + "ThemeColor": "#0960bd" + }, + "Layout": { + "FullContent": false, + "ContentMode": "full", + "ShowLogo": true, + "ShowFooter": true, + "ShowBreadCrumb": true, + "ShowBreadCrumbIcon": false + }, + "Menu": { + "Mode": "inline", + "Theme": "dark", + "Width": 210, + "Collapsed": false, + "Split": false, + "Draggable": true + }, + "Header": { + "Fixed": true, + "Theme": "light", + "ShowFullScreen": true, + "ShowDoc": true, + "ShowNotice": true, + "ShowSearch": true + }, + "MultiTab": { + "Cache": true, + "Draggable": true, + "Refresh": true, + "Fold": true + } +} +``` + +## 使用说明 + +1. 主题配置 + * 支持多种主题模式切换 + * 可自定义主题色 + * 提供主题持久化存储 + +2. 布局配置 + * 灵活的布局模式 + * 可配置的页面元素显示 + * 支持响应式布局 + +3. 菜单配置 + * 多样的菜单显示模式 + * 支持菜单拖拽排序 + * 菜单主题自定义 + +4. 扩展开发 + * 支持自定义主题配置提供者 + * 可扩展的主题设置项 + * 主题数据本地化支持 + +## 注意事项 + +1. 主题配置 + * 主题配置会影响所有用户的界面显示 + * 建议根据实际需求选择合适的主题模式 + +2. 性能考虑 + * 合理配置标签页缓存数量 + * 适当使用页面加载动画 + +## 更多信息 + +* [VueVbenAdmin主题配置文档](https://doc.vvbin.cn/guide/design.html) +* [ABP官方文档](https://docs.abp.io/) diff --git a/aspnet-core/modules/platform/README.EN.md b/aspnet-core/modules/platform/README.EN.md new file mode 100644 index 000000000..b1dbf769e --- /dev/null +++ b/aspnet-core/modules/platform/README.EN.md @@ -0,0 +1,96 @@ +# LINGYUN.Platform + +Platform management module that provides a complete set of platform management features, including menu management, layout management, data dictionary, package management, and more. + +## Features + +* Menu Management + * Multi-level menu structure + * User menu customization + * Role-based menu permissions + * Menu favorites + * Dynamic menu presets + +* Layout Management + * Layout view entities + * Layout data association + * Multi-framework support + +* Data Dictionary + * Data dictionary management + * Dictionary item management + * Dictionary seed data + +* Package Management + * Package version control + * Package file management + * Blob storage integration + * Package filtering specifications + +* VueVbenAdmin Integration + * Theme settings + * Layout settings + * Menu settings + * Header settings + * Multi-tab settings + +## Project Structure + +* `LINGYUN.Platform.Domain.Shared`: Shared domain layer +* `LINGYUN.Platform.Domain`: Domain layer +* `LINGYUN.Platform.EntityFrameworkCore`: Data access layer +* `LINGYUN.Platform.Application.Contracts`: Application service contracts layer +* `LINGYUN.Platform.Application`: Application service implementation layer +* `LINGYUN.Platform.HttpApi`: HTTP API layer +* `LINGYUN.Platform.Settings.VueVbenAdmin`: VueVbenAdmin frontend framework settings module + +## Quick Start + +1. Reference the modules +```csharp +[DependsOn( + typeof(PlatformDomainModule), + typeof(PlatformApplicationModule), + typeof(PlatformHttpApiModule), + typeof(PlatformSettingsVueVbenAdminModule) +)] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +2. Configure the database +```json +{ + "ConnectionStrings": { + "Platform": "Server=localhost;Database=Platform;Trusted_Connection=True" + } +} +``` + +3. Update the database +```bash +dotnet ef database update +``` + +## Important Notes + +1. Dynamic Menu Management + * The module initializes vue-admin related menus by default + * Menu data can be preset through the `IDataSeedContributor` interface + * Layout (path) and menu (component) do not need the @/ prefix + +2. Database Migration + * Please execute database migration before running the platform service + * Use the `dotnet ef database update` command to update the database structure + +## More Information + +* [Shared Domain Layer](./LINGYUN.Platform.Domain.Shared/README.EN.md) +* [Domain Layer](./LINGYUN.Platform.Domain/README.EN.md) +* [Data Access Layer](./LINGYUN.Platform.EntityFrameworkCore/README.EN.md) +* [Application Service Contracts Layer](./LINGYUN.Platform.Application.Contracts/README.EN.md) +* [Application Service Implementation Layer](./LINGYUN.Platform.Application/README.EN.md) +* [HTTP API Layer](./LINGYUN.Platform.HttpApi/README.EN.md) +* [VueVbenAdmin Settings Module](./LINGYUN.Platform.Settings.VueVbenAdmin/README.EN.md) diff --git a/aspnet-core/modules/platform/README.md b/aspnet-core/modules/platform/README.md index 850eda505..e3ff3e3ec 100644 --- a/aspnet-core/modules/platform/README.md +++ b/aspnet-core/modules/platform/README.md @@ -1,27 +1,96 @@ -# LINGYUN.Platform.Domain +# LINGYUN.Platform -平台管理模块 +平台管理模块,提供了一套完整的平台管理功能,包括菜单管理、布局管理、数据字典、包管理等功能。 -#### 注意 +## 功能特性 -> 动态菜单管理 +* 菜单管理 + * 多级菜单结构 + * 用户菜单定制 + * 角色菜单权限 + * 菜单收藏功能 + * 动态菜单预置 - ## IDataSeedContributor - 说明: 用于预置菜单数据的接口,模块默认已初始化与vue-admin相关的菜单 +* 布局管理 + * 布局视图实体 + * 布局数据关联 + * 多框架支持 - ## 其他注意事项 +* 数据字典 + * 数据字典管理 + * 数据字典项管理 + * 数据字典种子数据 - 1、不论是布局(path)还是菜单(component),都不需要添加 @/ 的前缀(这通常在前端定义路由时需要),因为前端不支持这样的形式 +* 包管理 + * 包版本控制 + * 包文件管理 + * Blob存储集成 + * 包过滤规范 - 2、请在运行平台服务之前,执行 dotnet ef database update 更新平台服务数据结构 - +* VueVbenAdmin集成 + * 主题设置 + * 布局设置 + * 菜单设置 + * 标题栏设置 + * 多标签页设置 -## 配置使用 +## 项目结构 +* `LINGYUN.Platform.Domain.Shared`: 共享领域层 +* `LINGYUN.Platform.Domain`: 领域层 +* `LINGYUN.Platform.EntityFrameworkCore`: 数据访问层 +* `LINGYUN.Platform.Application.Contracts`: 应用服务契约层 +* `LINGYUN.Platform.Application`: 应用服务实现层 +* `LINGYUN.Platform.HttpApi`: HTTP API层 +* `LINGYUN.Platform.Settings.VueVbenAdmin`: VueVbenAdmin前端框架设置模块 +## 快速开始 + +1. 引用模块 ```csharp -[DependsOn(typeof(PlatformDomainModule))] +[DependsOn( + typeof(PlatformDomainModule), + typeof(PlatformApplicationModule), + typeof(PlatformHttpApiModule), + typeof(PlatformSettingsVueVbenAdminModule) +)] public class YouProjectModule : AbpModule { - // other + // other } +``` + +2. 配置数据库 +```json +{ + "ConnectionStrings": { + "Platform": "Server=localhost;Database=Platform;Trusted_Connection=True" + } +} +``` + +3. 更新数据库 +```bash +dotnet ef database update +``` + +## 注意事项 + +1. 动态菜单管理 + * 模块默认已初始化与vue-admin相关的菜单 + * 可以通过 `IDataSeedContributor` 接口预置菜单数据 + * 布局(path)和菜单(component)不需要添加 @/ 前缀 + +2. 数据库迁移 + * 请在运行平台服务之前执行数据库迁移 + * 使用 `dotnet ef database update` 命令更新数据库结构 + +## 更多信息 + +* [共享领域层](./LINGYUN.Platform.Domain.Shared/README.md) +* [领域层](./LINGYUN.Platform.Domain/README.md) +* [数据访问层](./LINGYUN.Platform.EntityFrameworkCore/README.md) +* [应用服务契约层](./LINGYUN.Platform.Application.Contracts/README.md) +* [应用服务实现层](./LINGYUN.Platform.Application/README.md) +* [HTTP API层](./LINGYUN.Platform.HttpApi/README.md) +* [VueVbenAdmin设置模块](./LINGYUN.Platform.Settings.VueVbenAdmin/README.md)