mytweets

私のツイート

すべてのツイートを検索します。

特徴

• Twitter アーカイブ データのアーカイブのインポートを許可する
  • これは、このアプリがあなたのすべてのTwitter履歴の検索をサポートしていることを意味します
• Twitter と Bluesky をサポート
• Twitter API/BlueSky API 経由で最新のツイートを取得し、履歴と結合します
  • また、GitHub Actionsによる自動化も可能です
• あなたのツイートのためのウェブフロントエンド!
  • すべてのツイートの全文検索をサポート
  • S3 選択ベースの全文検索
  • 自分専用のプライベート検索エンジンを作成できます

概要

使用法

1. 「このテンプレートとフォークされたリポジトリを使用する」をクリックします
   • パブリックまたはプライベートを選択できます
2. git clone フォークされたリポジトリ

git clone https://github.com/you/mytweets
cd mytweets

このアプリケーションには次のトークンが必要です。

• Twitter APIトークン
• S3 アクセスキー
• Tweets.json を保存するための S3 バケット

これらを.envファイルに置く必要があります。

cp .env.example .env

ツイッター

1. Twitter V2 API クライアントの作成
2. APIキー、APIキーシークレット、アクセストークン、アクセストークンシークレットの取得
3. これらを.envファイルに配置します

 S3_AWS_ACCESS_KEY_ID="x"
S3_AWS_SECRET_ACCESS_KEY="x"
S3_AWS_REGION="us-east-1"
S3_BUCKET_NAME="x"
TWITTER_APP_KEY="YOUR_TWITTER_API_KEY"
TWITTER_APP_SECRET="YOUR_TWITTER_API_KEY_SECRET"
TWITTER_ACCESS_TOKEN="YOUR_TWITTER_ACCESS_TOKEN"
TWITTER_ACCESS_SECRET="YOUR_TWITTER_ACCESS_TOKEN_SECRET"

S3

1. ツイートを保存するための S3 バケットを作成します。
2. AWS IAMでAPIキーを作成する
   • この API キーには S3 の GET、PUT、List 権限が必要です

権限ポリシーの例:

YOUR_S3_BUCKET_NAMEはステップ 1 のバケット名です。

{
  "Version" : " 2012-10-17 " ,
  "Statement" : [
    {
      "Sid" : " mytweets " ,
      "Effect" : " Allow " ,
      "Action" : " s3:* " ,
      "Resource" : " arn:aws:s3:::{your-mytweets-bucket-name}/* "
    }
  ]
}

3. API トークンと S3 バケット名を.envファイルに配置します。

S3_AWS_ACCESS_KEY_ID= " x "
S3_AWS_SECRET_ACCESS_KEY= " x "
S3_AWS_REGION= " us-east-1 "
S3_BUCKET_NAME= " x "
TWITTER_APP_KEY= " YOUR_TWITTER_API_KEY "
TWITTER_APP_SECRET= " YOUR_TWITTER_API_KEY_SECRET "
TWITTER_ACCESS_TOKEN= " YOUR_TWITTER_ACCESS_TOKEN "
TWITTER_ACCESS_SECRET= " YOUR_TWITTER_ACCESS_TOKEN_SECRET " 

ブルースカイ

Bluesky の投稿を取得したい場合は、 yarn run fetch-tweetsの代わりに、 yarn run fetch-bsky使用できます。

1. bluesky アカウントを.envに追加します。

 S3_AWS_ACCESS_KEY_ID = "x"
S3_AWS_SECRET_ACCESS_KEY = "x"
S3_AWS_REGION = "us-east-1"
S3_BUCKET_NAME = "x"
BLUESKY_IDENTIFIER = "xxx.bsky.social"
BLUESKY_APPPASSWORD = "x"

2. [更新ワークフロー](./.github/workflows/update.yml) で、 yarn run fetch-tweetsの代わりに、 yarn run fetch-bskyを使用します。

Twitter アーカイブからインポート

1. Twitter アーカイブをリクエストする
2. twitter-*.zipのような Twitter アーカイブ ファイルをダウンロードします。
3. tweeet*.js twitter-archives/にコピーします

 twitter-archives/
├── tweet.js
├── tweet-part1.js
└── tweet-part2.js

4. インポート コマンドを実行します。

 yarn install
yarn import-twitter-archives # Concvert twitter-archives
yarn fetch-tweets  # Fetch diffs via Twitter API
yarn upload-s3 # upload to S3

最新のツイートを取得してマージします

必須: .envファイル内のTWITTER_*およびS3_* env

Twitter API を使用して Twitter アカウントから最新のツイートを取得します。

yarn fetch-tweetsコマンドはツイートを取得し、 tweets.jsonにマージします。 yarn upload-s3 tweets.json S3 バケットにアップロードします。

 yarn install
yarn download-s3 # download tweets.json from S3
yarn fetch-tweets  # Fetch diffs via Twitter API
yarn prefetch-bsky  # Fetch diffs via Bluesky API
yarn upload-s3 # upload to S3

Web サイトの展開

Vercel のような Web ホスティングに Web フロントエンドをデプロイできます。

1. Vercel アカウントを作成する
2. 新しいプロジェクトを作成する
3. 「Gitリポジトリのインポート」を選択します
4. フォークされたリポジトリを選択してください
5. web/ 「ルートディレクトリ」に設定します
6. 「環境変数」に以下の値を設定します。
   • S3_AWS_ACCESS_KEY_ID
   • S3_AWS_SECRET_ACCESS_KEY
   • S3_BUCKET_NAME
   • NEXT_PUBLIC_AUTH_KEY=<secure random string>
   • ️ Web サイトへのアクセスを制限したい場合は、安全なランダム文字列をNEXT_PUBLIC_AUTH_KEYに設定する必要があります。
   • Web サイトへのパブリック アクセスを許可する場合は、 "public"をNEXT_PUBLIC_AUTH_KEY=publicに設定する必要があります。
7. 展開する
8. https://<yourmytweets>.vercel.app/?k=<NEXT_PUBLIC_AUTH_KEY>のように Web サイトにアクセスできます。

デフォルトの検索クエリ

https://<yourmytweets>.vercel.app/?k=<NEXT_PUBLIC_AUTH_KEY>&q=<search keyword>&max=<max search count>

Web アプリは次の URL クエリをサポートしています。

• ?k=<Your Secret Key - same with NEXT_PUBLIC_AUTH_KEY>
• &q=<search keyword>
• &max=<max search count>
  • デフォルト: 20

ヒント

スケジュールの更新

GitHub Action のような CI を使用して、 yarn fetch-tweetsとyarn upload-s3自動化できます。

このテンプレート リポジトリには、 tweets.json毎日更新する .github/workflows/update.yml が含まれています。

1. フォーク リポジトリの設定https://github.com/owner/mytweets/settings/secrets/actionsにアクセスします。
2. Actionのシークレットに以下のenvを入れます
   • S3_AWS_ACCESS_KEY_ID
   • S3_AWS_SECRET_ACCESS_KEY
   • S3_AWS_REGION
   • S3_BUCKET_NAME
   • ツイートを取得したい場合
     • TWITTER_APP_KEY
     • TWITTER_APP_SECRET
     • TWITTER_ACCESS_TOKEN
     • TWITTER_ACCESS_SECRET
   • Bluesky の投稿を取得したい場合
     • BLUESKY_IDENTIFIER
     • BLUESKY_APPPASSWORD

これらの値は.envと同じです。

関連している

• azu/delete-tweets: Twitterのアーカイブから削除候補のツイートを抽出する補助ツールと削除ツールする。

変更履歴

リリースページを参照してください。

テストの実行

devDependency をインストールし、 npm testを実行します。

 npm test

貢献する

プルリクエストやスターはいつでも大歓迎です。

バグや機能リクエストについては、問題を作成してください。

1. フォークしてください！
2. 機能ブランチを作成します: git checkout -b my-new-feature
3. 変更をコミットします: git commit -am 'Add some feature'
4. ブランチにプッシュ: git push origin my-new-feature
5. プルリクエストを送信してください:D

著者

• azu: GitHub、Twitter、Bluesky

ライセンス

MIT © あず