Kawpaa

Kawpaa is web service to assist your masturbation life.

NOTE: データの登録にはSave-to-Kawpaaの利用が必要です。

起動に必要なもの

• Git
• Docker

想定環境

• Windows10 Home

起動手順

0. 事前準備

Git および Docker をインストールして、git コマンドおよび docker-compose コマンドが実行できるようにしてください。

詳細

0-1. Git をインストールします(すでにインストール済みであれば作業不要です)。以下のリンクからインストーラをダウンロードしてください。

Git

0-2. ダウンロードしたインストーラを実行してインストールします。(初期設定を変更する必要は特になく Next ボタンを押下していくだけで大丈夫です)

0-3. 以下のリンクの準備 ～インストールのセクションの内容を参考に Docker をインストールしてください。(すでにインストール済みであれば作業不要です)

Windows 10 Home への Docker Desktop (ver 3.0.0) インストールが何事もなく簡単にできるようになっていた (2020.12 時点) - Qiita

1. TwitterAPI の利用申請

以下のリンクから Twitter API の利用申請をして、Callback URLsの登録およびConsumer KeyとConsumer Secretの取得が必要です。
もし、アプリケーションをローカルに立ち上げる場合は、申請時にCallback URLsの入力欄にhttps://127.0.0.1:9021/auth/twitter/callbackを指定してください。

Twitter Developer Platform

詳細

1-1. Twitter開発者申請を行います。

Twitter にログインした状態で下記リンク先のヘッダーのApplyをクリックします。

Twitter Developer Platform

Apply for a developer accountをクリックします。

Hobbyistを選択して、Explorer the APIを選択し、Get startedをクリックします。

フォームを埋めてNextをクリックします。

TwitterAPI と TwitterData の用途を聞かれるので英語で適当に答えます。 DeepL で英語に翻訳した文章でも通ります。自分は以下のように記入しました。

1. I want to provide login authentication using Twitter OAuth on the service I develop and operate.
2. I want to improve the efficiency of users by collecting and displaying tweets that match specific criteria.

下にスクロールすると追加で用途を聞かれますが、以下 3 つにチェックを入れて同様に英語で記入していきます。記入したらNextを押下します。

• Are you planning to analyze Twitter data?

  • I want to analyze the tweets that are popular with users that are automatically tweeted using Twitter API from my service.

• Will you app use Tweet, Retweet, Like, Follow, or Direct Message functionally?

  • I want to provie OAuth authenticated users with the ability to ReTweet and Like tweets displayed on my service.

• Do you plan to display Tweets or aggregate data about Twitter content outside Twitter?

  • I want to display to tweets that match certain criteria on my service to improve the efficiency of users.

入力内容に誤りがなければ、Nextをクリックします。

認証待ち画面に遷移します。登録中のメールアドレスに認証用メールが送信されますのでメールの内容に従って Verify します。

Verify が完了すると承認待ちになるのでしばらく待ちます。自分の場合は数時間で承認されました。

1-2. TwitterAPI の利用申請を行います。

開発者申請承認後、開発者用ページに飛ぶとアプリ名を入力するよう指示されますので重複しない適当な名前を入力してGet keysを押下します。

API KeyとAPI Secret Keyが表示されるのでコピーしておきます。

本 README では、それぞれ以下のように対応しますので適宜読み替えてください。

• API Key ⇔ ConsumerKey
• API Secret Key ⇔ ConsumerSecret

Skip to dashboardをクリックします。

左メニューのProject & Apps > Project 1 > <先程入力したアプリ名>をクリックします。
Authentication settingsのEditをクリックします。

Enable 3-legged OAuthを有効にし、Callback URLsにhttps://127.0.0.1:9021/auth/twitter/callbackを入力します。

画面下までスクロールし、Saveをクリックします。

2. プロジェクトの clone

$ git clone https://github.com/eiurur/Kawpaa.git
$ cd Kawpaa

詳細

2-1. git-bash を起動してください。

2-2. プロジェクトの clone、ディレクトリの移動を行ってください。

$ git clone https://github.com/eiurur/Kawpaa.git
$ cd Kawpaa

3. 設定の変更

.env.docker.sampleを.env.dockerに改名します。

$ mv .env.docker.sample .env.docker

.env.dockerをエディタで開いて、TW_CK、TW_CS、CALLBACK_URLをそれぞれ ① で得られた値に変更してください。

変更前

- TW_CK=<CHANGE HERE...Twitter consumer key>
- TW_CS=<CHANGE HERE...Twitter consumer secret>
- CALLBACK_URL=<CHANGE HERE...Twitter callback url>

変更後(例)

- TW_CK=XXX1234567890ABCDEFGHIXXX
- TW_CS=ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWX
- CALLBACK_URL=https://127.0.0.1:9021/auth/twitter/callback

詳細

3-1. .env.docker.sampleを.env.dockerに改名してください。

$ mv .env.docker.sample .env.docker

3-2. .env.dockerの内容のうち、TW_CK、TW_CS、CALLBACK_URLをそれぞれ ① で得られた値に変更してください。notepad コマンドを実行するとメモ帳が開きます。変更が終わりましたら保存してメモ帳を閉じてください。

$ notepad .env.docker

変更前

変更後(例)

4. アプリケーションの起動

$ docker-compose up -d --build

詳細

4-1. docker-compose up -d --buildを実行してアプリケーションを起動してください。

$ docker-compose up -d --build

起動開始

起動完了後

4-2. タスクバーの docker アイコンを右クリックしてDashboardメニューを左クリックし、kawpaa コンテナが立ち上がっていることを確認してください。

5. URL にアクセス

ブラウザを起動して https://127.0.0.1:9021/ にアクセスします

詳細

5-1. ブラウザを起動してhttps://127.0.0.1:9021にアクセスします。詳細設定>127.0.0.1にアクセスする(安全ではありません)をクリックしてください。Kawpaa のトップ画面が表示されたら作業完了です。

その他

• コンテンツの登録には Chrome Extension が必要です。こちらから最新版をダウンロードしてください。

• ローカルで立ち上げず、VPS やクラウドで立ち上げる場合は、上記手順ならびにソースコードのhttps://127.0.0.1:9021を各自のドメインに置き換えてください。

  • また、ChromeExtensionも同様の置き換えを行った上で再ビルドが必要ですのでご注意ください。
    

トラブルシューティング

Q. Danbooru の画像が保存できない

A. Danbooruの画像を保存するには Danbooru の API Key が必要です。

以下の手順に従って、API Key の登録をしてください。

1. ログイン画面でログインまたはユーザの登録をしてください。

2. ユーザ画面の API Key の View リンクをクリックしてください。

3. Add ボタンから必要なパーミッションを付与した API Key を作成してください。Name は任意、IP Address は空欄。Permissions は「explore/posts:popular」「explore/posts:searches」「explore/posts:viewed」「posts:show」の 4 つを選択してください。

4. .env.dockerのDANBOORU_USERNAMEにログインで使用するユーザ名を、DANBOORU_API_KEYに API キー一覧画面のKeyを設定してください。

5. 「4. アプリケーションの起動」の手順にしたがってアプリケーションを再起動してください。