Skip to content
ポピンズメモリーを取得して Slack に通知するツール
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
src
.babelrc
.env.example
.envrc.example
.eslintrc.js
.gitignore
.npmignore
Dockerfile
README.md
docker-compose.yml
index.js
package.json
yarn.lock

README.md

ポピンズメモリーレポーター

CircleCI

これは何?

ポピンズナーサリースクールの会員マイページ https://ps.poppins.co.jp/nursery/login/index にある連絡ページ「ポピンズメモリー」の情報を取得してSlackに通知を行うツールです。

開発要件

以下の条件で開発しています。

環境変数について

このツールは、以下の環境変数を利用します。

環境変数名 説明 必要条件
USER_ID ログインID 必須
PASSWORD ログインパスワード 必須
SLACK_WEBHOOK_URL Webhook URL(設定しない場合は通知しない) 任意
SLACK_CHANNEL 通知チャンネル(設定しない場合はデフォルト) 任意
REPORT_TODAY 定義すると当日を通知する(デフォルトは前日) 任意

環境変数の定義方法については自由ですが、ローカル環境では direnv、Docker 環境では .env ファイルを利用することを想定しています(とても単純な名前なので、グローバルに定義するのは危険です)。

それぞれ .envrc.example.env.example を用意していますので、それぞれコピーして利用してください。

$ cp .envrc.example .envrc
or
$ cp .env.example .env

# そして編集

起動方法

起動方法はローカル(Node)環境とDocker環境の2種類があります。

また、Slack に通知するためには Incoming Webhooks の Webhook URL を事前に取得して環境変数にセットしておく必要があります。

ローカル(Node)環境

ローカル(Node)環境の起動方法は、基本的に一般的な Node アプリケーションと同じで、モジュールをインストールして実行するだけです。実行前に direnv を利用して環境変数を定義しておきましょう。

$ yarn install
$ yarn start
or
$ npm install
$ npm start

特に問題なければ、これで実行できます。

Docker 環境

ローカルでビルドする場合は docker-compose を利用するのが簡単です。.env ファイルが必須なので、事前に準備さえしておけば、以下のコマンドだけで実行できます。

$ docker-compose up

もし、ソースコードが不要な場合は、Docker Hub からイメージを取得して実行することも可能です。その場合は、次のようにして実行します。

$ docker pull tomoyaton/poppins-memory-reporter
$ docker run --env-file=.env tomoyaton/poppins-memory-reporter

ToDo

  • 独自でスケジュール実行できるようにしたい
  • Google Spreadsheed に記録したい
  • 取得する情報を増やしたり、表示/非表示を調整できるようにする
You can’t perform that action at this time.