/Auto-push-word

learn-English

Primary LanguageShellMIT LicenseMIT

words-flashcard

每日背单词记忆卡片(GRE佛脚词汇)

一个既可以满足快速刷完单词书,又可以满足每日在Github上面打卡成就感的小玩具 : )

当然,单词书可以自己换。整理成(直接去下载)excel 表格的单词书就行了(按照本仓库提供的格式),欢迎 fork 和改善。

查看签到表 --> 签到表 📖

Features ? (功能指南)

  • 每日从仓库电子表格中选取一部分单词,自动写入每日的 Markdown 文件里(也就是在 ./days 下创建一个新的文档用于放置今日的单词)。
  • 自动将新的单词 push 到你的 Github 帐号下,可以直接将 Github 变成新的背单词工具,每天更新自定义数目 (默认30个) 新单词,每天坚持打卡,直到将整本单词书背完。

待开发功能:

  • 复习功能,将之前几天背完的单词乱序按照一定记忆曲线重新 push 到每日单词计划中。

How to Use ? (使用指南)

  • 在开始使用之前,请先确保你有一台配置好 Git 的电脑(服务器)。
  • 将本项目 fork 到自己的 Github 账号下。
  • 将自己的 fork 克隆 (clone) 到服务器主机上,配置好 Github,使其能够有权限推送。
  • 配置好对应的依赖,可以使用repo中带的requirement.txt (懒得写版本号,大家就用pur凑合更新到最新版就好)。
  • 运行脚本:sudo sh deploy.sh

设置每日自动推送

  • 输入: crontab -e
  • 在文件末尾加入一行: 00 00 * * * /root/words-flashcard/deploy.sh (路径根据clone位置决定)。
  • 00 00代表每日零点自动执行该脚本,可以自定义。

update

使用指南(详细版本)

  • 由于脚本使用的是python,所谓配置依赖,指的是配置好服务器or电脑的python运行环境,首先应该安装配置python3,然后配置python的包管理软件pip安装该脚本所需的模块,具体所需模块在项目的requirements.txt文件中。
  • clone路径尽量选择 /root/words-flashcard,否则会出现文件混乱导致脚本无法执行的问题,有能力者可通过修改代码去除影响
  • clone后的文件夹名是words-everyday,如上条所说,请修改为words-flashcard。
  • 设置每日推送运用的是linux的cron服务,可以自行了解cron服务的具体使用,以达到自定义的效果