目录

• 目录
• 1 关于
  • 1.1 项目目录简介
  • 1.2 项目启动及部署
• 2 设计
  • 2.1 数据表
    • 2.1.1 users表
    • 2.1.2 tasks表
    • 2.1.3 assignments表
  • 2.2 接口设计
    • 2.1.1 用户模块
    • 2.1.2 邮箱模块
    • 2.1.3 认证模块
    • 2.1.4 任务模块
    • 2.1.5 作业模块

1 关于

这是一个在线众包平台的服务端，作为我们软件工程(3)的大作业项目。以下是项目的相关链接。

• 后端项目GitHub地址
• 移动端前端项目GitHub地址
• 桌面端前端项目GitHub地址
• 用户故事文档
• 项目自动生成文档

1.1 项目目录简介

文档主要是有一下几个部分：

• docs/：存放文档（不同于自动生成文档）
• README.md：自动生成文档的首页

自动文档会依据注释生成，具体格式可以参照Use JSDoc: Getting Started with JSDoc 3。

代码主要是：

• test/：项目测试代码
• src/：项目核心代码
  • models/：model数据层
  • core/：controller控制层，操纵数据层
  • api/：RESTful API的事件处理
  • socket/：Socket.io的事件处理
  • wechat/：微信消息推送的事件处理
  • server.js：整个服务端的对象
• app.js：启动src/server.js
• config.json：项目的配置文件（在.gitignore中）
• package.json：npm的配置文件

因而整个项目模块之间的依赖如下：

此外还有额外的配置：

• .editorconfig：编辑器配置
• .eslintrc：代码风格检查工具配置（这是强制的，不通过就报错）
• .jsdoc.json：自动文档生成配置
• .travis.yml：Travis CI配置

1.2 项目启动及部署

本项目依赖两个数据库：

• MongoDB
• Redis

配置完这两个数据库后，可以通过如下命令启动server：

# Install Dependencies
npm install
# Start Server
node app # Or `npm start`

建议提交前应当跑一下测试：

# Check coding style
npm run lint
# Unit test
npm run test

部署项目自动文档到GitHub上可以采用如下方式：

# Generate documentation from code
npm run docs
# Deploy documentation to GitHub Pages
npm run gh-pages

当然每次提交之后会有CI自动测试并部署文档。

2 设计

2.1 数据表

2.1.1 users表

见models/users~User。

2.1.2 tasks表

见models/tasks~Task。

2.1.3 assignments表

用户到作业和任务到作业都是一对多的关系。通过引入作业表，问题得以简化。

见models/assignments~Assignment。

2.2 接口设计

借口主要以两种方式接入：

1. AJAX请求：见api
2. Socket.IO事件：见socket

2.1.1 用户模块

注意：用户的邮箱注册请参考邮箱模块，用户的登录请参照认证模块。

见core/user。

2.1.2 邮箱模块

见core/email。

2.1.3 认证模块

见core/auth。

2.1.4 任务模块

见core/task。

2.1.5 作业模块

见core/assignment。