article
README
🚀 Gauntlet-Incept 教育内容生成系统
Gauntlet-Incept 教育内容生成系统专为 K - 8 学生打造,能够生成高质量的教育内容。该系统初始聚焦于特定学科领域的文章和问题银行开发,为教育场景提供有力支持。
🚀 快速开始
本项目旨在构建一个为 K - 8 学生生成高质量教育内容的系统。若你想了解项目详情,可查看以下文档:
- 项目概述 - 详细描述项目目标和需求
- 实施检查清单 - 项目实现的全面检查清单
- 原始项目简报 - 原始项目需求的详细简报
- MCP 服务器指南 - 使用 Claude Desktop 配置 Model Context Protocol 服务器的指南
📚 详细文档
项目提供了丰富的文档资源,方便你深入了解项目:
- 项目概述:详细阐述了项目目标和需求,让你对项目有宏观的认识。
- 实施检查清单:是项目实现过程中的全面检查清单,可用于把控项目进度。
- 原始项目简报:包含了原始项目需求的详细信息。
- MCP 服务器指南:指导你如何使用 Claude Desktop 配置 Model Context Protocol 服务器。
🏗️ 项目结构
项目的文件和目录结构如下:
gauntlet-incept/
├── docs/ # 文档文件夹
├── src/ # 源代码
│ ├── api/ # API 路由
│ ├── models/ # 数据模型
│ ├── services/ # 业务逻辑
│ ├── utils/ # 工具函数
│ ├── data/ # 数据文件
│ ├── tests/ # 测试文件
│ ├── index.js # REST API 入口点
│ └── mcp-server.js # Model Context Protocol 服务器
├── services/ # 微服务
│ ├── qti-service/ # QTI 服务用于内容存储
│ └── llm-service/ # LLM 服务用于内容生成
├── .env.example # 环境变量示例文件
├── .gitignore # Git 忽略文件
├── package.json # Node.js 包文件
├── docker-compose.yml # Docker Compose 配置
├── Dockerfile # Docker 配置
└── README.md # 此文件
📄 API 文档
项目实现了六个核心 API 端点,具体如下:
问题端点
POST /api/question/tag:使用主题、年级、标准、课程和难度标记一个问题。POST /api/question/grade:根据质量标准对已标记的问题进行评分。POST /api/question/generate:基于标签或示例问题生成一个问题。
文章端点
POST /api/article/tag:使用主题、年级、标准和课程标记一篇文章。POST /api/article/grade:根据质量标准对已标记的文章进行评分。POST /api/article/generate:基于标签或示例文章生成一篇文章。
🔧 MCP 服务器配置
MCP 服务器用于与 Claude Desktop 集成,配置命令如下:
npm run mcp
📋 项目检查清单
以下是项目的检查清单,展示了项目的进度:
- [x] 初始化 Git 仓库
- [x] 创建基本项目结构
- [x] 添加 .gitignore 文件
- [x] 创建初始提交
- [x] 设置项目文档
- [x] 创建实施检查清单
- [x] 设置 API 路由和服务结构
- [x] 实现核心服务的占位功能
- [x] 设置 Docker 容器化
- [x] 实现 MCP 服务器用于 Claude Desktop 集成
- [x] 配置与 RDS PostgreSQL 数据库的连接
- [ ] 实现实际功能与 LLM 集成
- [ ] 添加测试
- [ ] 审查并最终确定
📄 许可证
本项目采用 MIT 许可证。
📞 联系方式
[你的联系方式]
扫码联系在线客服