{"topic":{"id":4880,"title":"课程信息功能开发项目","slug":"topic","userId":1047,"categoryId":2,"createdAt":"2024-01-31 16:00:00","bumpedAt":"2024-01-31 16:00:00","views":769,"postsCount":1,"highestPostNumber":1,"likeCount":1,"closed":false,"pinned":false,"pinnedGlobally":false,"pinnedAt":null,"pinnedUntil":null,"isBanner":false,"excerpt":"Intro 之前挖了个坑，一直没有动力去填： system: 类似 USTC 评课社区，汇集不同课程以及不同老师的教学班的信息。 upload_bot: 经常有“求推荐通识选修课/通识核心课”的问题，网上有个【金山文档】西安交大基础通识类课程推荐表 https://kdocs.cn/l/csz66VHlZ9NC ，搬到这里来了，已设为 Wiki，所有人可编辑。咱今天就来打造一个 XJTU 评课社区。该以什么样的形式呈现呢？可能的…","deletedAt":null,"isAnonymous":false,"isPrivate":false,"isMembersOnly":false,"category":{"id":2,"name":"网站","slug":"website","color":"986a44"},"author":{"id":1047,"username":"anonymous_coward_old","name":"Anonymous Coward Old","avatarUrl":"/uploads/image/43/32/4332638c11248b8ff07033c11de0759a55205facfbec85e14458245a91991faf.avif"},"realAuthor":{"id":1047,"username":"anonymous_coward_old","name":"Anonymous Coward Old","avatarUrl":"/uploads/image/43/32/4332638c11248b8ff07033c11de0759a55205facfbec85e14458245a91991faf.avif"},"tags":["course"]},"posts":[{"id":9214,"postNumber":1,"raw":"## Intro\n之前挖了个坑，一直没有动力去填：\n\n[quote=\"system, post:1, topic:1585, full:true\"]\n类似 [USTC 评课社区 ](https://icourse.club/)，汇集**不同课程**以及**不同老师的教学班**的信息。\n[/quote]\n\n[quote=\"upload_bot, post:1, topic:4778\"]\n经常有“求推荐通识选修课/通识核心课”的问题，网上有个【金山文档】西安交大基础通识类课程推荐表 [https://kdocs.cn/l/csz66VHlZ9NC ](https://kdocs.cn/l/csz66VHlZ9NC)，搬到这里来了，已设为 Wiki，所有人可编辑。\n[/quote]\n\n咱今天就来打造一个 XJTU 评课社区。\n\n该以什么样的形式呈现呢？\n\n## 可能的解决方案\n### 采用 ustc 评课社区的代码\n最简单的做法是，克隆一下 [ustc 评课社区的代码](https://github.com/USTC-iCourse/ustc-course)，部署一下即可\n\n> USTC 评课社区是使用 Python 3 + Flask + SQLAlchemy 开发的 Web 系统。\n\n[wrap=color color=green bgcolor=#] 优点：[/wrap] 开发效率高，二次开发容易。USTC 评课社区的界面看起来挺清爽的，功能很丰富，还有 [培养方案查询](https://icourse.club/program/)，[最受欢迎的老师和课程](https://icourse.club/stats/rankings/)，[统计信息可视化](https://icourse.club/stats/)，[社区规范](https://icourse.club/community-rules/) 和 [ 投诉点评的流程](https://icourse.club/report-review/) 都有一定的参考价值。\n\n\n![Screenshot_20230814_164210|405x500, 75%](/uploads/image/3d/a5/3da529afeded1620fd0235fff7a4354343963aa93965a968001d946836de3fbc.avif)\n\n[wrap=color color=red bgcolor=#] 缺点：[/wrap] [闭源依赖问题](https://github.com/USTC-iCourse/ustc-course/issues/29)，[MariaDB+Python 太重型以至于性能不行/对硬件要求高](https://icourse.club/announcements/) ：\n> 再次扩容到 4 核 8G，CPU 仍然是 100%，但是访问变快了很多\n\n最重要的缺点是无法利用现有的 Discourse 的功能。不过也许可以和交大門共用一套用户系统（SSO）。\n\n\n### 基于 Lemmy 的二次开发\n目前的 [交大門 L](https://l.xjtu.app/) 的 UI 有一点点像 USTC 评课社区，具有二次开发的可能性。\n[wrap=color color=green bgcolor=#] 优点：[/wrap]\n* Rust Actix 高性能、轻量、安全性\n[wrap=color color=red bgcolor=#] 缺点：[/wrap]\n* Rust 学习上手较难，生命周期 Borrow Checker 使得代码无法成功编译的可能性较大\n\n### 使用各种编程语言从 0 开始开发\n适合网络应用的开发编程语言、各种框架多得是。缺点是造轮子很不容易，优点是很锻炼开发者。 \n\n### 开发 Discourse 插件\n可参考 https://meta.discourse.org/t/topic-ratings-plugin/39578\n![image|690x472](/uploads/image/e8/c6/e8c6761ad6026bbdc35e10b473c4f4340366c6c16f5959ff485662a33a7abb63.avif)\n\n#### 优缺点\n[wrap=color color=green bgcolor=#] 优点：[/wrap]\n* 可以和交大門 [现有的众多功能](/t/topic/127) *有机地* 结合起来，利用现有的用户系统，编辑器，匿名回复/发帖功能，Wiki 功能\n* 考虑到 Discourse 使用的是 Ruby on rails 的技术栈，开发插件不难\n* 不会因为 UI 完全不同造成其他板块**割裂**\n* 可以复用到 https://xjtu.app/c/teachers/15 板块\n[wrap=color color=red bgcolor=#] 缺点：[/wrap]\n* 没法一上来就直接拥有 USTC 评课社区有的拥有众多成熟评课的功能\n\n## Steps\n### 预备知识\nDiscourse 有丰富的开源插件和 Theme(Component)，以下是官方的指南：\n\n\n\n\n### 业务逻辑和组织\n受 [USTC 评课社区的 UI 启发](#ustc-course-screenshot)\n\n```python\n## Data Models:\n\nclass 课程 { @linkable\n @bindAction 收藏/关注 \n 客观属性 {\n 学校的编号 Str\n 学分 Num\n 学时 Num\n 教学单位/学院 Enum @linkable\n 简介 Str\n class 类型 {\n 层次（本科 / 硕 / 博）Enum\n 培养方案里要求为必修的学院/专业 Enum\n 选修课类型（核心/通识，对于必修课为 None）Option(Enum)\n }\n 先修课程 NeedsPrerequisite List[Self] // 例如电路对于模拟电子技术而言\n 是先修课程 ProvidesPrerequisiteFor List[Self] // 和上一行相反\n 冲突课程 ConflictsWith List[Self] // 例如高数 I 和高数 II\n 类似/相关课程 List[Self]\n }\n -> Derived {\n 课程*好评*度\n UpdatedAt Date\n 所有教学班评价的总结 Str\n }\n}\n\nclass 教学班 extends 课程 { @linkable\n 客观属性 += {\n class 教师 { Str @unique @linkable\n 简介 Str\n 个人主页地址（gr.xjtu）Str\n 交大門教师信息地址 Str\n -> Derived {\n 平均课程*好评*度\n }\n }\n }\n \n List[ @sortable by 评价的优质程度 &/ 开课学期（年份 + 季节）&/ 总体的推荐度\n @groupable by 开课学期（年份 + 季节） &/ 总体的推荐度\n class 评价信息 { @linkable\n 评价人 Str @unique @linkable\n 开课学期（年份 + 季节）Num+Enum @linkable @nullable\n 难度 Enum\n 作业量 Enum\n 给分吝惜度 Enum\n 总体学习收获多少 Enum\n 详细的文字评价 Str\n 总体的推荐度 Enum\n UpdatedAt Date\n class 他人对该评价的评价 { @linkable\n Upvote (Informative / Neutral / Objective) Count(Bool)\n Downvote (Low-entropy / Biased / Emotional) Count(Bool)\n 他人对该评价的文字评价 Str\n }\n -> Derived {\n 他人认为该评价的优质程度 Num\n }\n \n }, \n ]\n \n -> Derived {\n 教学班*好评*度\n set(开课学期（年份 + 季节）) set(Num+Enum)\n UpdatedAt Date\n 所有评价的总结 Str\n }\n}\n\n\n## Views\n// Basic Views\n[_ for _ in all(课程)]\n// _ 课程的所有教学班\n[_.children for _ in all(课程)]\n[_ for _ in all(教学班)]\n[_ for _ in all(评价信息)]\n\n// XX 教师的所有课程\n[_ for _ in all(课程) if 课程。教师 == XX]\n\n// XX 学院的所有课程\n[_ for _ in all(课程) if 课程.(教学单位/学院) == XX]\n\n```\n\n\n#### 信息格式\n```\nDict 课程 { \n 客观属性 {\n 学校的编号 Str\n 学分 Num\n 学时 Num\n 教学单位/学院 Enum \n 简介 Str\n Dict 类型 {\n 层次（本科 / 硕 / 博）Enum\n 选修课类型（核心/通识，对于必修课为 None）Option(Enum)\n }\n List[Dict 教学班信息 {\n 教师\n 开课学期（年份 + 季节）\n ...\n },\n ]\n Optional {\n 先修课程 NeedsPrerequisite List[Self] // 例如电路对于模拟电子技术而言\n 是先修课程 ProvidesPrerequisiteFor List[Self] // 和上一行相反\n 冲突课程 ConflictsWith List[Self] // 例如高数 I 和高数 II\n 类似/相关课程 List[Self]\n }\n }\n}\n```\n\n### 临时的解决方法\n将表格中的不同课程信息上传为不同的话题。\n\n## See Also\n后续建设可以看看 [USTC 评课社区背后的故事](https://jenny42.com/20220702-a-story-of-USTC-iCourse/)，[USTC 学习资料](https://www.zhangjy9610.me/USTCdata.html)。","cooked":"

Intro

之前挖了个坑，一直没有动力去填：

\n\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\tsystem:\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t

\n
类似 USTC 评课社区，汇集不同课程以及不同老师的教学班的信息。
\n

\n\t\t\t\t\t\t

\n\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\tupload_bot:\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

\n\t\t\t\t\t\t\t

\n
经常有“求推荐通识选修课/通识核心课”的问题，网上有个【金山文档】西安交大基础通识类课程推荐表 https://kdocs.cn/l/csz66VHlZ9NC ，搬到这里来了，已设为 Wiki，所有人可编辑。
\n

\n\t\t\t\t\t\t

咱今天就来打造一个 XJTU 评课社区。

该以什么样的形式呈现呢？

可能的解决方案

采用 ustc 评课社区的代码

最简单的做法是，克隆一下 ustc 评课社区的代码，部署一下即可

\n
USTC 评课社区是使用 Python 3 + Flask + SQLAlchemy 开发的 Web 系统。
\n

优点：开发效率高，二次开发容易。USTC 评课社区的界面看起来挺清爽的，功能很丰富，还有培养方案查询，最受欢迎的老师和课程，统计信息可视化，社区规范和投诉点评的流程都有一定的参考价值。

\n $\"Screenshot_20230814_164210\"$

缺点：闭源依赖问题，MariaDB+Python 太重型以至于性能不行/对硬件要求高：

\n
再次扩容到 4 核 8G，CPU 仍然是 100%，但是访问变快了很多
\n

最重要的缺点是无法利用现有的 Discourse 的功能。不过也许可以和交大門共用一套用户系统（SSO）。

基于 Lemmy 的二次开发

目前的交大門 L 的 UI 有一点点像 USTC 评课社区，具有二次开发的可能性。
\n 优点：

Rust Actix 高性能、轻量、安全性
\n 缺点：
Rust 学习上手较难，生命周期 Borrow Checker 使得代码无法成功编译的可能性较大

使用各种编程语言从 0 开始开发

适合网络应用的开发编程语言、各种框架多得是。缺点是造轮子很不容易，优点是很锻炼开发者。

开发 Discourse 插件

可参考 Topic Ratings Plugin
\n $\"image\"$

优缺点

优点：

可以和交大門现有的众多功能 有机地 结合起来，利用现有的用户系统，编辑器，匿名回复/发帖功能，Wiki 功能
考虑到 Discourse 使用的是 Ruby on rails 的技术栈，开发插件不难
不会因为 UI 完全不同造成其他板块割裂
可以复用到 /c/teachers/15 板块
\n 缺点：
没法一上来就直接拥有 USTC 评课社区有的拥有众多成熟评课的功能

Steps

预备知识

Discourse 有丰富的开源插件和 Theme(Component)，以下是官方的指南：
\nhttps://meta.discourse.org/t/beginners-guide-to-developing-discourse-themes/93648
\nhttps://meta.discourse.org/t/developing-discourse-plugins-part-1-create-a-basic-plugin/30515

业务逻辑和组织

受 USTC 评课社区的 UI 启发

## Data Models:\n\nclass 课程 { @linkable\n            @bindAction 收藏/关注 \n    客观属性 {\n        学校的编号 Str\n        学分 Num\n        学时 Num\n        教学单位/学院 Enum @linkable\n        简介 Str\n        class 类型 {\n            层次（本科 / 硕 / 博）Enum\n            培养方案里要求为必修的学院/专业 Enum\n            选修课类型（核心/通识，对于必修课为 None）Option(Enum)\n        }\n        先修课程 NeedsPrerequisite   List[Self] // 例如电路对于模拟电子技术而言\n        是先修课程 ProvidesPrerequisiteFor   List[Self] // 和上一行相反\n        冲突课程 ConflictsWith   List[Self] // 例如高数 I 和高数 II\n        类似/相关课程   List[Self]\n    }\n    -> Derived {\n            课程*好评*度\n            UpdatedAt Date\n            所有教学班评价的总结 Str\n        }\n}\n\nclass 教学班 extends 课程 { @linkable\n    客观属性 += {\n        class 教师 { Str @unique @linkable\n            简介 Str\n            个人主页地址（gr.xjtu）Str\n            交大門教师信息地址 Str\n            -> Derived {\n                   平均课程*好评*度\n               }\n        }\n    }\n    \n    List[ @sortable by 评价的优质程度 &/ 开课学期（年份 + 季节）&/ 总体的推荐度\n          @groupable by 开课学期（年份 + 季节） &/ 总体的推荐度\n        class 评价信息 { @linkable\n            评价人 Str @unique @linkable\n            开课学期（年份 + 季节）Num+Enum @linkable @nullable\n            难度 Enum\n            作业量 Enum\n            给分吝惜度 Enum\n            总体学习收获多少 Enum\n            详细的文字评价 Str\n            总体的推荐度 Enum\n            UpdatedAt Date\n            class 他人对该评价的评价 { @linkable\n                Upvote (Informative / Neutral / Objective) Count(Bool)\n                Downvote (Low-entropy / Biased / Emotional) Count(Bool)\n                他人对该评价的文字评价 Str\n            }\n            -> Derived {\n                   他人认为该评价的优质程度 Num\n               }\n                \n          }, \n    ]\n    \n    -> Derived {\n            教学班*好评*度\n            set(开课学期（年份 + 季节）) set(Num+Enum)\n            UpdatedAt Date\n            所有评价的总结 Str\n        }\n}\n\n\n## Views\n// Basic Views\n[_ for _ in all(课程)]\n// _ 课程的所有教学班\n[_.children for _ in all(课程)]\n[_ for _ in all(教学班)]\n[_ for _ in all(评价信息)]\n\n// XX 教师的所有课程\n[_ for _ in all(课程) if 课程。教师 == XX]\n\n// XX 学院的所有课程\n[_ for _ in all(课程) if 课程.(教学单位/学院) == XX]\n\n

信息格式

Dict 课程 { \n    客观属性 {\n        学校的编号 Str\n        学分 Num\n        学时 Num\n        教学单位/学院 Enum \n        简介 Str\n        Dict 类型 {\n            层次（本科 / 硕 / 博）Enum\n            选修课类型（核心/通识，对于必修课为 None）Option(Enum)\n        }\n        List[Dict 教学班信息 {\n            教师\n            开课学期（年份 + 季节）\n            ...\n        },\n       ]\n        Optional {\n            先修课程 NeedsPrerequisite   List[Self] // 例如电路对于模拟电子技术而言\n            是先修课程 ProvidesPrerequisiteFor   List[Self] // 和上一行相反\n            冲突课程 ConflictsWith   List[Self] // 例如高数 I 和高数 II\n            类似/相关课程   List[Self]\n        }\n    }\n}\n

临时的解决方法

将表格中的不同课程信息上传为不同的话题。