Skip to content

NWUCA/NWU.ICU

Repository files navigation

NWU.ICU

目前拥有导航, 课程评价两个模块.

起步

本项目使用 Django 开发, 并使用 poetry 来管理依赖.

  • 安装依赖:
    poetry install
    
  • 进入虚拟环境:
    poetry shell
    
  • 根据 development.py.sample 建立 development.py 配置文件.
  • 建立数据库:
    python manage.py migrate
    
  • 运行开发服务器:
    python manage.py runserver
    

部署

  • 确保 clone 了整个仓库.. (版本号模块使用了 git describe)
  • 根据 production.py.sample 建立 production.py 配置文件
  • 配置静态文件
  • 初始化数据库
  • 执行 start.sh
  • 配置反向代理

目前生产环境的部署流程见这里.

自动填报

report/trigger_report.sh 加入 crontab 中.

Roadmap

  • 首页添加类似 ustc.life 的导航
  • PWA
  • 课程评价的 UX 改进
  • 使用 templatetags 代替手写 bulma 风格的 forms
  • 调研是否能够集成 mypy
    • 目前 django-stubs (1.12) 尚不支持 django 4.1
  • 图表统计 (metabase? 看起来非常不错)

TODO

  • 生产环境的配置, static files, DEBUG, 以及启动脚本
  • logging
  • 静态文件的图片 404 了
  • 使用 django form
  • 登录的 throttle
  • 引导用户设置昵称

课程评价

  • 查看自己的评价
  • 评价的编辑历史
  • 用星星显示评分
  • 富文本编辑 (quill?)
  • 课程的分页
  • 课程和评价列表改成卡片
  • 搜索
  • 评价的日期时间

贡献

欢迎提 PR 或 issue.

commit 之前请运行 pre-commit 以确保代码格式规范.