docs(backend): 重构后端README文档,完善项目文档与开发指南

- 全面更新README,添加项目特性、架构设计与技术栈介绍
- 详细补充项目结构说明及模块设计规范
- 增加快速开始步骤,包括环境配置、数据库初始化和服务启动
- 补充主要API模块路径和认证授权使用示例
- 添加开发指南、数据库迁移与测试方法
- 集成监控、日志级别说明及性能监控内容
- 完善Docker、传统部署及Nginx配置示例
- 添加贡献指南和代码规范说明
- 新增MCP模块概述及智能对话API接口文档
- 清理和移除module_ai中旧的mcp_server相关实现代码
- 在api/v1初始化文件中注册AI模块路由
- 修改resource模块,增强资源路径安全检查和文件类型检测逻辑
- 增强资源搜索和上传服务的健壮性及安全性
This commit is contained in:
zhangtao
2025-09-08 00:45:34 +08:00
parent 8cb93d31d1
commit 01fd6c8ea4
66 changed files with 5692 additions and 5193 deletions
+12 -3
View File
@@ -4,6 +4,8 @@ arrowParens: "always"
bracketSameLine: false
# 对象字面量中的括号之间添加空格
bracketSpacing: true
# 在对象字面量中,如果属性名需要引号,则使用单引号
singleAttributePerLine: false
# 自动格式化嵌入的代码(如 Markdown 和 HTML 内的代码)
embeddedLanguageFormatting: "auto"
# 忽略 HTML 空白敏感度,将空白视为非重要内容
@@ -12,8 +14,8 @@ htmlWhitespaceSensitivity: "ignore"
insertPragma: false
# 在 JSX 中使用双引号
jsxSingleQuote: false
# 每行代码的最大长度限制为 100 字符
printWidth: 100
# 每行代码的最大长度限制为 200 字符
printWidth: 200
# 在 Markdown 中保留原有的换行格式
proseWrap: "preserve"
# 仅在必要时添加对象属性的引号
@@ -34,8 +36,15 @@ useTabs: false
vueIndentScriptAndStyle: false
# 根据系统自动检测换行符
endOfLine: "auto"
# 对 HTML 文件应用特定格式化规则
# 对特定文件类型应用更宽松的格式化规则
overrides:
- files: "*.html"
options:
parser: "html"
- files: "*.vue"
options:
printWidth: 300
singleAttributePerLine: false
- files: "*.{js,ts}"
options:
printWidth: 250