everyclass/everyclass

Personal curriculum schedule subscription & powerful information query tool for your college life at CSU

EveryClass @ CSU - Personal curriculum schedule subscription & powerful information query tool for your college life at CSU

每课 @ CSU - 个人课表订阅 & 强大的信息查询工具，为你的 CSU 校园生活量身定做

For English version please scroll down.

Chinese 中文

介绍

通过每课，你可以：

• 查询学生、教师的课表
• 查询课程详情
• 查询教室时间安排和空教室信息
• 生成你的课表 WebCal(iCal) 文件，你可以将其导入到手机和电脑的日历（支持iOS、Mac、安卓），让课程和你的其他日历事项在同一处展示，更便于时间管理

如果你是中南大学的学生，直接访问 https://everyclass.xyz 即可使用本程序的功能，无需阅读下面的内容；如果你来自其他大学，你可以邀请小伙伴们 fork 这个项目并创建适用于自己的学校的分支。

代码仓库

• everyclass-server：提供面向终端用户的 web 服务，基于 Flask
• everyclass-collector：数据爬取与处理模块
• everyclass-api-server：API-server 微服务，提供数据查询

---

English

Introduction

Using EveryClass, you can:

• Getting a teacher or student's course schedule
• Getting rich information of a course
• Query schedule of a classroom, and see which classroom is not engaged
• Generating an .ics file that could be imported to calender app so you can view your daily schedule in one place(Chinese college students often use a standalone app to view their course schedule instead of calender app)

Code Repositories

• EveryClass-server：Providing web service to end user. Based on Flask.
• EveryClass-collector：Data crawling and processing
• everyclass-api-server：API-server micro-service. Offers data querying service

everyclass's Issues

咕咕机打印课表

建议增加手动课表更新功能（解决退选课后的课表更新问题）

如题。

上帝视角-学期甘特图

每课的一项新功能为“上帝视角”，它包括两个子功能：

• 学期上帝视角：在学生（或老师）的学期课表页增加入口，点击进入后可以查看本学期本人的课程甘特图。它使得用户可以俯瞰整个学期的课程时间分布，便于用户查看空闲周和忙碌周以调整自己的其他事情。
• 周次上帝视角：在学生（或老师）的学期课表页增加入口，点击进入后选择周次，就可以通过棋盘格子的形式展现本周的课表与空闲时间（类似于超级课程表或课程格子 app 中的效果）

本 issue 期望实现的是“学期上帝视角”。

原型&效果图

入口

上帝视角页

注意事项：

• 应确保在电脑和手机端都有良好的展现，尤其是手机端
• 选择前端插件的时候需要考虑和现有 JS 的兼容性

空教室查询功能

根据校区和教学楼查询空教室。

每天凌晨刷新“数据最后更新日期”

用户登录增加验证码

防止被机器人炸

安卓客户端定期自动同步

为了和 iOS 端表现一致，安卓客户端应该支持定期自动同步课表

课表隐私级别

• 对不同的级别进行信息隐藏
• 允许已登录用户设置自己的隐私级别

高级搜索功能付费

新版每课即将推出高级搜索功能，可以通过各种拼音简写的方式来搜索。每课已经服务中南学子两年，而收入方面一致入不敷出，为了平衡收入与支出，高级搜索功能（可能）需要付费。

目前计划会员制或者按次数收费。

发送邮件和网页验证的 APM measure

每日隐私调整数量统计

使用 Hyperloglog 数据结构，定时任务将指标发送到ES，每日统计0点清零

安卓端用户机制的接入

目前设置了隐私的用户都不能正常使用安卓端，接入用户机制之后他们可以通过输入密码的方式订阅。

依赖服务器端开放用户机制

关于研究生的课表支持

rt.

优化学生验证邮件内容页

现在的太丑了

安卓客户端接入 Sentry SDK

server 适配新版 api-server

API Server 改为使用学号，编码工作移动到 Server

server 数据库连接池不够健壮

ics 日历订阅自定义提醒时间

学生身份验证服务无法正常使用

• 邮件验证重复发邮件
• 密码验证一直不过

新的后端架构

目前我们的后端架构如下图所示：

基于前后端分离、为 PWA 做准备、以及降低模块耦合、采用更先进和现代化的架构的考虑，我们计划迁移到下图的架构：

该架构的优势在于：

• 防止 everyclass-server 随着业务的增加而膨胀成一个巨大的单体
• 降低各个模块的耦合，每个小服务可以更加快速的迭代，代码中出现严重错误时影响范围更小
• entity 等子服务无需自行实现用户身份验证、限流等基础功能，全部交由网关实现，降低了小服务的开发成本
• 未来的前后端分离时，客户端无需了解服务器端架构，使用单一的 HTTPS API 域名即可完成所有功能

目前该方案出于草案阶段，欢迎大家提出建议。

课程打分体系

[Sentry:EVERYCLASS-SERVER-1T8] 教室没有课程时不应返回 404 而是 card 列表为空

注册时提示密码强度，避免提交后才反馈

验证码服务是否需要换一个？

很多用户反馈验证码（目前使用的是谷歌的 recaptcha）很烦，是否有必要换一个验证码服务？

会员功能

• 调查个人可以使用的收款接口
• 接入收款平台
• 会员体系
• 优惠码功能

预计会员特权

高级查询

• 模糊搜索
• 空教室查询

功能

• 手动更新自己的课表
• 上帝视角：甘特图
• 修正自己的上课时间地点
• ics 自定义提醒时间

特权

• 隐身访问

根据时间查询空教室功能

安卓端新 UI 设计

允许用户修正自己的上课时间、地点

有的课程可能会变更上课地点，但是教务系统中的信息并不会修改。为了解决这一问题，我们可以建立一个“上课地点修补”表，保存对于单个用户的地点修改记录，来覆盖从教务爬取的数据。

容器使用 supervisor 作为 PID1 进程以支持正确的 SIGTERM 退出方式

reference：https://yq.aliyun.com/articles/5545

使用多学期一致的课程 ID

#17 依赖于api-server的此功能

另：class、course、lesson 命名有关讨论

API Server 提供元数据

API Server 向使用方提供元数据，包括数据最后更新时间等