跳到主要内容

FreeKit Pro Modules

基于 .NET 10 的模块化 DDD 方案,文档以当前仓库代码为准,覆盖默认宿主、模块注册、部署方式与共享基础库。

快速导航

入口说明
快速入门FreeKit.Hostdocker-compose.ymllaunchSettings.json 为准的启动说明
技术栈介绍当前默认宿主、模块注册表与基础设施选型
一键部署build\run_freekit_pro_modules.* 与 Compose 部署说明
配置项参考Host / Job / Message 三类宿主的关键配置段
新模块指南IModuleStartupE.Modules 接入新模块
API 总览真实路由前缀、响应模型与 Swagger 入口
常见问题针对当前代码结构整理的排障说明
FreeKit 基础库FreeKit Core、Extras、Modularity 与扩展库文档
BuildingBlocks仓库内公共基础设施与 Web 组件说明

当前默认宿主

默认运行入口位于 src\Services\Host\

宿主项目作用本地默认地址
主 APIFreeKit.Host聚合业务 API、Swagger/RapiDoc、SignalR、健康检查https://localhost:7002/kit_api / http://localhost:5002/kit_api
JobFreeKit.Job.HostFreeScheduler 任务宿主与任务初始化入口https://localhost:7000/job_api / http://localhost:5000/job_api
MessageFreeKit.MessageHandler.HostCAP 消费端与消息处理入口https://localhost:7003/message_api / http://localhost:5003/message_api
HealthChecksFreeKit.HealthChecks独立基础设施健康检查 UIhttps://localhost:5005 / http://localhost:5004

默认启用的模块

以下模块来自 src\Services\Host\FreeKit.DI\E.csModules 注册表:

注册键Startup所属目录说明
identityIdentityModuleStartupsrc\Services\Identity\FreeKit.Identity认证、权限、组织、SSO、OAuth2
identity-infIdentityInfrastructureModuleStartupsrc\Services\Identity\FreeKit.Identity.Infrastructure公共附件、设置等基础能力
platformPlatformModuleStartupsrc\Services\Plat\FreeKit.Platform区域、导航、热点、工具、代码生成
holidayHolidayModuleStartupsrc\Services\Holiday\Holidays节假日数据接口
todoToDoModuleStartupsrc\Services\ToDo\FreeKit.ToDos待办示例模块
cmskitCmsKitModuleStartupsrc\Services\CmsKit\FreeKit.CmsKit文章、短内容、评论、通知、推荐、检索
toolkitToolKitModuleStartupsrc\Services\CmsKit\FreeKit.Toolkit工具集合与代理能力
imImModuleStartupsrc\Services\IM\FreeKit.IM即时通讯、好友、群组、消息反应
memberMemberModuleStartupsrc\Services\Identity\FreeKit.Member会员积分、地址等扩展能力
shortShortModuleStartupsrc\Services\Plat\FreeKit.Short短链能力

src\Services\Mall 中还包含 FreeKit.Mall 代码,但当前默认 FreeKit.Host 未将其加入 E.Modules

技术栈速览

层次技术
Web 框架ASP.NET Core / .NET 10
模块化IGeekFan.FreeKit.Modularity
ORMFreeSql(CodeFirst)
缓存FreeRedis
定时任务FreeScheduler
消息总线CAP + RabbitMQ
日志Serilog
实时通信SignalR
搜索MeiliSearch
文档Swagger UI + RapiDoc

文档说明

本网站同时包含两类内容:

  1. docs/services/doc/**:面向当前 FreeKitModules 工程的整理文档。
  2. docs/repo/**:从仓库内 README / 设计文档整理进站点的镜像文档。