mytweets

我的推文

搜索你所有的推文。

特征

• 允许导入 Twitter 存档数据的存档
  • 这意味着这个应用程序支持搜索你的所有推特历史记录
• 支持 Twitter 和 Bluesky
• 通过 Twitter API/BlueSky API 获取最新推文并与您的历史记录合并
  • 此外，它可以通过 GitHub Actions 自动化
• 您的推文的网络前端！
  • 支持对您的所有推文进行全文搜索
  • 基于 S3 Select 的全文搜索
  • 您可以为您创建私人搜索引擎

概述

用法

1. 单击使用此模板和分叉存储库
   • 您可以选择公共或私人
2. git 克隆分叉的存储库

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-bsky而不是yarn run fetch-tweets 。

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-bsky而不是yarn run fetch-tweets

从 Twitter 存档导入

1. 请求您的 Twitter 存档
2. 下载 Twitter 存档文件，例如twitter-*.zip
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

部署网站

您可以像 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>
   • ️如果您想限制对您网站的访问，您应该将安全随机字符串设置为NEXT_PUBLIC_AUTH_KEY
   • 如果您想允许公众访问您的网站，则应将"public"设置为NEXT_PUBLIC_AUTH_KEY=public
7. 部署
8. 您可以访问您的网站，例如https://<yourmytweets>.vercel.app/?k=<NEXT_PUBLIC_AUTH_KEY> 。

默认搜索查询

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

尖端

时间表更新

您可以使用 CI（如 GitHub Action）自动执行yarn fetch-tweets和yarn upload-s3 。

此模板存储库包含每天更新您的tweets.json .github/workflows/update.yml。

1. 访问您的分叉存储库的设置https://github.com/owner/mytweets/settings/secrets/actions
2. 将以下 env 放入 Action 的秘密中
   • 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

执照

麻省理工学院 © azu