From 66774c10030a2d14df614714029d282869b075e2 Mon Sep 17 00:00:00 2001
From: bouzuya <m@bouzuya.net>
Date: Sun, 7 Aug 2022 08:59:04 +0900
Subject: [PATCH] twiq: Update readme

---
 twiq/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/twiq/README.md b/twiq/README.md
index 5658fcee..7caffc9f 100644
--- a/twiq/README.md
+++ b/twiq/README.md
@@ -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
+```