# class-broker2

**Repository Path**: contexter/class-broker2

## Basic Information

- **Project Name**: class-broker2
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-06
- **Last Updated**: 2021-07-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

========
课程中控
========

课程业务中，学生和老师的客户端需要进行交互，如聊天、笔迹传输，这些服务对实时性有较高的要求。
采用 WebSocket 协议来满足业务对实时性的需求。

分支管理
========

采用 `master` + `develop` + `feature` 模式进行开发

`feature` 用于开发新的特性
`develop` 用于合并特性后去 `SIT` （测试环境）测试
`master` 用于测试完成后去 `PRD` 生产环境部署


文档
====

具体文档请到 `docs` 查看

功能
=====

1. 消息的广播推送：如聊天消息、教师发送的状态指令
2. 笔迹的广播推送：笔迹流可以实时推送到多个客户端


技术栈
======

* Web框架: Tornado
* 数据存储: Redis
* 消息广播: RabbitMQ


代码设计
========

对代码采用逻辑分层的方式进行组织，主要分为以下4个级别

DB(存储) -> Manager(资源接口) -> Service(业务逻辑) -> View(接口调用)


开发规范
========

1. 代码风格遵循 `pep8` ，开发人员需要安装 `pre-commit` 完成静态代码检测
2. 注意填写有意义的 commit msg， 可以参考 http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

pre-commit
**********

1. 安装 `pip install pre-commit`
2. 激活pre-commit `pre-commit install`
3. 试运行 pre-commit `pre-commit run --all-files`
4. 每次commit时都会自动触发步骤3检测


部署
====

采用 Docker 进行部署，