Skip to content

Commit

Permalink
twiq: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bouzuya committed Aug 6, 2022
1 parent 9177b6b commit 66774c1
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions twiq/README.md
Expand Up @@ -6,3 +6,45 @@

- 設定に従ってツイートを収集する
- 収集したツイートから検索する

## メモ

- 何のためにつくるのか
- Cloud Firestore の検証
- 自身のツイートのバックアップの提供
- 過去のツイートを検索する CLI の提供
(twilog.org の代替)
- どのようにつくるのか
- 全体像は構成図を参照
- 詳細は未定
- 構成要素ごとの役割
- cli は web に検索クエリを発行する
- db は情報を保持する
- scheduler は定期的に worker を動かす
- web は cli からの呼び出しに応じて db を読み込んで返す
- worker は twitter から情報を読み込み db に書き込む

## 構成図

```mermaid
graph LR
bouzuya
subgraph twiq
subgraph client
cli
end
subgraph server["server (GCP)"]
web["web (Cloud Run)"]
worker["worker (Cloud Run)"]
db["db (Cloud Firestore)"]
scheduler["scheduler (Cloud Scheduler)"]
scheduler --> worker
web -- read --> db
worker -- write --> db
end
end
twitter
bouzuya --> cli
cli --> web
worker -- read --> twitter
```

0 comments on commit 66774c1

Please sign in to comment.