schulcloud/schulcloud-server
schulcloud
自动构建
基于Node.js和Feathers的Schul-Cloud后端服务器，提供教育云平台核心API服务，支持Swagger UI文档和MongoDB数据库集成。
1 次收藏下载次数: 0状态：自动构建维护者：schulcloud仓库类型：镜像最近更新：25 天前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Schul-Cloud Server
基于https://nodejs.org/en/%E5%92%8CFeathers%E6%9E%84%E5%BB%BA%E7%9A%84Schul-Cloud%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E6%8F%90%E4%BE%9B%E6%95%99%E8%82%B2%E4%BA%91%E5%B9%B3%E5%8F%B0%E7%9A%84%E6%A0%B8%E5%BF%83API%E6%9C%8D%E5%8A%A1%E3%80%82
开发状态与文档
- 开发分支构建状态：https://travis-ci.com/schul-cloud/schulcloud-server.svg?branch=develop](https://travis-ci.com/schul-cloud/schulcloud-server)
- 主分支构建状态：https://travis-ci.com/schul-cloud/schulcloud-server.svg?branch=master](https://travis-ci.com/schul-cloud/schulcloud-server)
- 代码覆盖率：https://codecov.io/gh/schul-cloud/schulcloud-server/branch/master/graph/badge.svg](https://codecov.io/gh/schul-cloud/schulcloud-server)
- 版本信息：https://img.shields.io/github/release/schul-cloud/schulcloud-server.svg](https://github.com/schul-cloud/schulcloud-server/releases)
Swagger UI文档
- 线上环境：[***]
- 本地运行时：http://localhost:3030/docs/
核心功能与特性
- 基于Node.js和Feathers框架构建的轻量级后端服务
- 集成MongoDB数据库进行数据存储与管理
- 提供Swagger UI接口文档，便于API调试与集成
- 完善的测试体系，支持单元测试与前端测试
- 标准化的开发流程（分支管理、代码提交规范）
使用场景
适用于Schul-Cloud教育云平台的后端服务支撑，处理用户请求、数据持久化、业务逻辑处理等核心功能，需配合https://github.com/schul-cloud/schulcloud-client%E4%BD%BF%E7%94%A8%E3%80%82
环境需求
- node.js
- MongoDB
安装与设置
前置条件
需同时安装https://github.com/schul-cloud/schulcloud-client%E3%80%82%E8%AF%A6%E7%BB%86%E8%AE%BE%E7%BD%AE%E6%8C%87%E5%8D%97%E5%8F%AF%E5%8F%82%E8%80%83%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%EF%BC%88%E6%96%87%E6%A1%A3%E5%9F%BA%E4%BA%8EWindows%E7%BC%96%E5%86%99%EF%BC%8C%E5%85%B6%E4%BB%96%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E6%B5%81%E7%A8%8B%E7%B1%BB%E4%BC%BC%EF%BC%89%E3%80%82
运行步骤
- 进入项目文件夹
- 启动MongoDB服务：
mongod - 启动服务器：
npm start - 执行初始化设置：
npm run setup
开发配置
Visual Studio Code调试配置
详细的Visual Studio Code设置指南可参考官方文档。
分支命名规范
- 从JIRA工单系统（ticketsystem.schul-cloud.org）获取工单编号，例如SC-999
- 分支名以工单编号开头，单词间用短横线分隔，格式示例：
SC-999-fantasy-problem - 创建PR时，标题需包含工单编号
- 开发中添加
[WIP]标签，完成后移除标签并请求审核（需满足定义的完成标准）
测试指南
运行测试
- 进入项目文件夹
- 执行测试命令：
npm run test
创建测试文件
- 在
/test/services目录下为目标"service"创建文件夹 - 创建前端测试文件（如用户交互测试）：
user.test.js（例如测试链接点击或URL可用性） - 创建后端测试文件（如业务逻辑测试）：
unit.test.js（例如数值计算测试）
测试目标：尽可能覆盖所有方法，追求100%单元测试覆盖率，建议每个方法对应一个测试用例。
代码提交流程
默认开发分支：develop
- 进入项目文件夹
- 运行测试（参见上述测试步骤）
- 提交代码时使用有意义的提交信息（避免无意义内容如"dfsdfsf"）
- 切换到master分支：
git checkout master - 拉取最新代码：
git pull - 切换回开发分支：
git checkout <你的分支名> - 执行变基操作（禁止使用
git merge）：git rebase -p develop，解决可能的合并冲突 - 推送分支：
git push
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 schulcloud-server 镜像标签
docker pull docker.xuanyuan.run/schulcloud/schulcloud-server:<标签>
DockerHub 原生拉取命令
docker pull schulcloud/schulcloud-server:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"