Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2 KB

README.md

File metadata and controls

53 lines (35 loc) · 2 KB

📡 twins-notification

筑波大学のTwinsの掲示板のお知らせを通知してくれるプログラムです。Twinsの掲示板を確認するのが大変な人のために作りました。

スクリーンショット

Slack通知のスクリーンショット

💻 Slackへの通知例

使い方

  1. .env.example.envにコピーする。
  2. .envに必要な情報を入力する。
  3. twins-notification.config.yamlを自分好みに設定する。

Node.jsを使用する場合

  1. yarn installを実行する(初回のみ)。
  2. yarn startを実行する。
  3. Slackに通知が来るはずです。

コンテナを使用する場合

make build
make run

KubernetesクラスタにCronJobとしてデプロイする場合

make build
make push
make deploy

現在の制限事項

  • WebhookのpayloadがSlackに適した形式にしか対応していません。
    • Slackの通知で満足してしまいそうなので、他の通知方法に対応するかどうかは未定です。RSSで出力したり、メールで1週間のお知らせを通知できたら嬉しいかも?
  • 通知範囲の指定方法が、「現在から指定日数前」以外に存在しません。
  • お知らせ一覧に書かれた情報しか通知してくれません。
    • Twinsには各お知らせに対するPermalinkが存在しないため、お知らせの詳細がわかりません。(issue #1)
  • エラーハンドリングをちゃんとしていません。

ライセンス

GNU General Public License v3.0

関連リポジトリ