schulcloud/schulcloud-server

Schul-Cloud Server

基于https://nodejs.org/en/和Feathers构建的Schul-Cloud后端服务器，提供教育云平台的核心API服务。

开发状态与文档

• 开发分支构建状态：
• 主分支构建状态：
• 代码覆盖率：
• 版本信息：

Swagger UI文档

• 线上环境：[***]
• 本地运行时：http://localhost:3030/docs/

核心功能与特性

• 基于Node.js和Feathers框架构建的轻量级后端服务
• 集成MongoDB数据库进行数据存储与管理
• 提供Swagger UI接口文档，便于API调试与集成
• 完善的测试体系，支持单元测试与前端测试
• 标准化的开发流程（分支管理、代码提交规范）

使用场景

适用于Schul-Cloud教育云平台的后端服务支撑，处理用户请求、数据持久化、业务逻辑处理等核心功能，需配合https://github.com/schul-cloud/schulcloud-client使用。

环境需求

• node.js
• MongoDB

安装与设置

前置条件

需同时安装https://github.com/schul-cloud/schulcloud-client。详细设置指南可参考官方文档（文档基于Windows编写，其他操作系统流程类似）。

运行步骤

1. 进入项目文件夹
2. 启动MongoDB服务：mongod
3. 启动服务器：npm start
4. 执行初始化设置：npm run setup

开发配置

Visual Studio Code调试配置

详细的Visual Studio Code设置指南可参考官方文档。

分支命名规范

1. 从JIRA工单系统（ticketsystem.schul-cloud.org）获取工单编号，例如SC-999
2. 分支名以工单编号开头，单词间用短横线分隔，格式示例：SC-999-fantasy-problem
3. 创建PR时，标题需包含工单编号
4. 开发中添加[WIP]标签，完成后移除标签并请求审核（需满足定义的完成标准）

测试指南

运行测试

1. 进入项目文件夹
2. 执行测试命令：npm run test

创建测试文件

1. 在/test/services目录下为目标"service"创建文件夹
2. 创建前端测试文件（如用户交互测试）：user.test.js（例如测试链接点击或URL可用性）
3. 创建后端测试文件（如业务逻辑测试）：unit.test.js（例如数值计算测试）

测试目标：尽可能覆盖所有方法，追求100%单元测试覆盖率，建议每个方法对应一个测试用例。

代码提交流程

默认开发分支：develop

1. 进入项目文件夹
2. 运行测试（参见上述测试步骤）
3. 提交代码时使用有意义的提交信息（避免无意义内容如"dfsdfsf"）
4. 切换到master分支：git checkout master
5. 拉取最新代码：git pull
6. 切换回开发分支：git checkout <你的分支名>
7. 执行变基操作（禁止使用git merge）：git rebase -p develop，解决可能的合并冲突
8. 推送分支：git push