feat(docs): enhance README and backend documentation for new user onboarding and backend conventions

- Added a "Start Here" section in both English and Chinese README files to guide new users on running the project locally and exploring its features.
- Introduced backend conventions for date and serialization handling, clarifying the use of Pydantic v2 and PostgreSQL.
- Updated the "Quick Start" section with detailed steps for first-time local setup, including environment requirements and backend setup instructions.
- Improved overall structure and clarity of documentation to facilitate better understanding for developers and contributors.
This commit is contained in:
zhangtao
2026-03-29 07:25:09 +08:00
parent bf26563083
commit d2a863652e
88 changed files with 4846 additions and 2558 deletions
+486 -328
View File
@@ -2531,392 +2531,550 @@
"title": "任务管理",
"params": null,
"affix": false,
"redirect": "/task/job",
"redirect": "/task/cronjob/job",
"description": "任务管理",
"children": [
{
"name": "调度器监控",
"type": 2,
"icon": "el-icon-DataLine",
"name": "定时任务",
"type": 1,
"icon": "el-icon-Timer",
"order": 1,
"permission": "module_task:job:query",
"route_name": "Job",
"route_path": "/task/job",
"component_path": "module_task/job/index",
"permission": null,
"route_name": "Cronjob",
"route_path": "/task/cronjob",
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "调度器监控",
"always_show": true,
"title": "定时任务",
"params": null,
"affix": false,
"redirect": null,
"description": "调度器监控",
"redirect": "/task/cronjob/job",
"description": "APScheduler 调度器与任务节点",
"children": [
{
"name": "查询调度器",
"type": 3,
"icon": null,
"name": "调度器监控",
"type": 2,
"icon": "el-icon-DataLine",
"order": 1,
"permission": "module_task:job:query",
"route_name": null,
"route_path": null,
"component_path": null,
"permission": "module_task:cronjob:job:query",
"route_name": "Job",
"route_path": "/task/cronjob/job",
"component_path": "module_task/cronjob/job/index",
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询调度器",
"title": "调度器监控",
"params": null,
"affix": false,
"redirect": null,
"description": "查询调度器"
"description": "调度器监控",
"children": [
{
"name": "查询调度器",
"type": 3,
"icon": null,
"order": 1,
"permission": "module_task:cronjob:job:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询调度器",
"params": null,
"affix": false,
"redirect": null,
"description": "查询调度器"
},
{
"name": "控制调度器",
"type": 3,
"icon": null,
"order": 2,
"permission": "module_task:cronjob:job:scheduler",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "控制调度器",
"params": null,
"affix": false,
"redirect": null,
"description": "控制调度器"
},
{
"name": "操作任务",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:cronjob:job:task",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "操作任务",
"params": null,
"affix": false,
"redirect": null,
"description": "操作任务"
},
{
"name": "删除执行日志",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:cronjob:job:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除执行日志",
"params": null,
"affix": false,
"redirect": null,
"description": "删除执行日志"
},
{
"name": "详情执行日志",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:cronjob:job:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情执行日志",
"params": null,
"affix": false,
"redirect": null,
"description": "详情执行日志"
}
]
},
{
"name": "控制调度器",
"type": 3,
"icon": null,
"name": "节点管理",
"type": 2,
"icon": "el-icon-Postcard",
"order": 2,
"permission": "module_task:job:scheduler",
"route_name": null,
"route_path": null,
"component_path": null,
"permission": "module_task:cronjob:node:query",
"route_name": "Node",
"route_path": "/task/cronjob/node",
"component_path": "module_task/cronjob/node/index",
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "控制调度器",
"title": "节点管理",
"params": null,
"affix": false,
"redirect": null,
"description": "控制调度器"
},
{
"name": "操作任务",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:job:task",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "操作任务",
"params": null,
"affix": false,
"redirect": null,
"description": "操作任务"
},
{
"name": "删除执行日志",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:job:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除执行日志",
"params": null,
"affix": false,
"redirect": null,
"description": "删除执行日志"
},
{
"name": "详情执行日志",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:job:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情执行日志",
"params": null,
"affix": false,
"redirect": null,
"description": "详情执行日志"
"description": "节点管理",
"children": [
{
"name": "创建节点",
"type": 3,
"icon": null,
"order": 1,
"permission": "module_task:cronjob:node:create",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "创建节点",
"params": null,
"affix": false,
"redirect": null,
"description": "创建节点"
},
{
"name": "调试节点",
"type": 3,
"icon": null,
"order": 2,
"permission": "module_task:cronjob:node:execute",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "调试节点",
"params": null,
"affix": false,
"redirect": null,
"description": "调试节点"
},
{
"name": "修改节点",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:cronjob:node:update",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "修改节点",
"params": null,
"affix": false,
"redirect": null,
"description": "修改节点"
},
{
"name": "删除节点",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:cronjob:node:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除节点",
"params": null,
"affix": false,
"redirect": null,
"description": "删除节点"
},
{
"name": "详情节点",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:cronjob:node:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情节点",
"params": null,
"affix": false,
"redirect": null,
"description": "详情节点"
},
{
"name": "查询节点",
"type": 3,
"icon": null,
"order": 6,
"permission": "module_task:cronjob:node:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询节点",
"params": null,
"affix": false,
"redirect": null,
"description": "查询节点"
}
]
}
]
},
{
"name": "节点管理",
"type": 2,
"icon": "el-icon-Postcard",
"name": "工作流",
"type": 1,
"icon": "el-icon-SetUp",
"order": 2,
"permission": "module_task:node:query",
"route_name": "Node",
"route_path": "/task/node",
"component_path": "module_task/node/index",
"permission": null,
"route_name": "WorkflowMgr",
"route_path": "/task/workflow-mgr",
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "节点管理",
"always_show": true,
"title": "工作流",
"params": null,
"affix": false,
"redirect": null,
"description": "节点管理",
"redirect": "/task/workflow/definition",
"description": "流程编排与编排节点类型",
"children": [
{
"name": "创建节点",
"type": 3,
"icon": null,
"name": "流程编排",
"type": 2,
"icon": "el-icon-SetUp",
"order": 1,
"permission": "module_task:node:create",
"route_name": null,
"route_path": null,
"component_path": null,
"permission": "module_task:workflow:definition:query",
"route_name": "Workflow",
"route_path": "/task/workflow/definition",
"component_path": "module_task/workflow/definition/index",
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "创建节点",
"title": "流程编排",
"params": null,
"affix": false,
"redirect": null,
"description": "创建节点"
"description": "Vue Flow 画布与发布执行",
"children": [
{
"name": "创建流程",
"type": 3,
"icon": null,
"order": 1,
"permission": "module_task:workflow:definition:create",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "创建流程",
"params": null,
"affix": false,
"redirect": null,
"description": "创建流程"
},
{
"name": "执行流程",
"type": 3,
"icon": null,
"order": 2,
"permission": "module_task:workflow:definition:execute",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "执行流程",
"params": null,
"affix": false,
"redirect": null,
"description": "执行流程"
},
{
"name": "修改流程",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:workflow:definition:update",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "修改流程",
"params": null,
"affix": false,
"redirect": null,
"description": "修改流程"
},
{
"name": "删除流程",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:workflow:definition:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除流程",
"params": null,
"affix": false,
"redirect": null,
"description": "删除流程"
},
{
"name": "详情流程",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:workflow:definition:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情流程",
"params": null,
"affix": false,
"redirect": null,
"description": "详情流程"
},
{
"name": "查询流程",
"type": 3,
"icon": null,
"order": 6,
"permission": "module_task:workflow:definition:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询流程",
"params": null,
"affix": false,
"redirect": null,
"description": "查询流程"
}
]
},
{
"name": "调试节点",
"type": 3,
"icon": null,
"name": "编排节点类型",
"type": 2,
"icon": "el-icon-Grid",
"order": 2,
"permission": "module_task:node:execute",
"route_name": null,
"route_path": null,
"component_path": null,
"permission": "module_task:workflow:node-type:query",
"route_name": "WorkflowNodeType",
"route_path": "/task/workflow/node-type",
"component_path": "module_task/workflow/node-type/index",
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "调试节点",
"title": "编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "调试节点"
},
{
"name": "修改节点",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:node:update",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "修改节点",
"params": null,
"affix": false,
"redirect": null,
"description": "修改节点"
},
{
"name": "删除节点",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:node:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除节点",
"params": null,
"affix": false,
"redirect": null,
"description": "删除节点"
},
{
"name": "详情节点",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:node:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情节点",
"params": null,
"affix": false,
"redirect": null,
"description": "详情节点"
},
{
"name": "查询节点",
"type": 3,
"icon": null,
"order": 6,
"permission": "module_task:node:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询节点",
"params": null,
"affix": false,
"redirect": null,
"description": "查询节点"
}
]
},
{
"name": "流程管理",
"type": 2,
"icon": "el-icon-FlowChart",
"order": 3,
"permission": "module_task:workflow:query",
"route_name": "Workflow",
"route_path": "/task/workflow",
"component_path": "module_task/workflow/index",
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "流程管理",
"params": null,
"affix": false,
"redirect": null,
"description": "流程管理",
"children": [
{
"name": "创建流程",
"type": 3,
"icon": null,
"order": 1,
"permission": "module_task:workflow:create",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "创建流程",
"params": null,
"affix": false,
"redirect": null,
"description": "创建流程"
},
{
"name": "调试流程",
"type": 3,
"icon": null,
"order": 2,
"permission": "module_task:workflow:execute",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "调试流程",
"params": null,
"affix": false,
"redirect": null,
"description": "调试流程"
},
{
"name": "修改流程",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:workflow:update",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "修改流程",
"params": null,
"affix": false,
"redirect": null,
"description": "修改流程"
},
{
"name": "删除流程",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:workflow:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除流程",
"params": null,
"affix": false,
"redirect": null,
"description": "删除流程"
},
{
"name": "详情流程",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:workflow:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情流程",
"params": null,
"affix": false,
"redirect": null,
"description": "详情流程"
},
{
"name": "查询流程",
"type": 3,
"icon": null,
"order": 6,
"permission": "module_task:workflow:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询流程",
"params": null,
"affix": false,
"redirect": null,
"description": "查询流程"
"description": "画布节点类型与 Prefect 执行逻辑",
"children": [
{
"name": "创建编排节点类型",
"type": 3,
"icon": null,
"order": 1,
"permission": "module_task:workflow:node-type:create",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "创建编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "创建编排节点类型"
},
{
"name": "修改编排节点类型",
"type": 3,
"icon": null,
"order": 2,
"permission": "module_task:workflow:node-type:update",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "修改编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "修改编排节点类型"
},
{
"name": "删除编排节点类型",
"type": 3,
"icon": null,
"order": 3,
"permission": "module_task:workflow:node-type:delete",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "删除编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "删除编排节点类型"
},
{
"name": "详情编排节点类型",
"type": 3,
"icon": null,
"order": 4,
"permission": "module_task:workflow:node-type:detail",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "详情编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "详情编排节点类型"
},
{
"name": "查询编排节点类型",
"type": 3,
"icon": null,
"order": 5,
"permission": "module_task:workflow:node-type:query",
"route_name": null,
"route_path": null,
"component_path": null,
"status": "0",
"keep_alive": true,
"hidden": false,
"always_show": false,
"title": "查询编排节点类型",
"params": null,
"affix": false,
"redirect": null,
"description": "查询编排节点类型"
}
]
}
]
}
@@ -3348,4 +3506,4 @@
}
]
}
]
]