docs/update readme #8
Loading…
Reference in New Issue
No description provided.
Delete Branch "docs/update-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
更新 README
docs: update readmeto docs/update readme@ -0,0 +9,4 @@
```bash
cd app-cloudep-notification-service
go mod tidy
make gen-rpc
有產生過只要 proto 沒有變動並不需要再次gen
@ -0,0 +26,4 @@
```bash
brew install protobuf
```
- etcd (https://etcd.io/)
這邊可以討論,就是開發時可以用 docker 啟用,應該可以不用直接安裝本地依賴
@ -0,0 +31,4 @@
brew install etcd
brew services start etcd
```
- SMTP 服務(以 mailhog 為例) (https://github.com/mailhog/MailHog)
SMTP 也是會直接依賴線上服務,除非有需要自己架設,但因為這個比較偏離 notification 的重點
比較偏好使用線上服務
可以討論一下 README 的格式跟內容,我是想說可以寫:
不過如果服務都是 docker 啟動、依賴線上服務的話,第二點似乎可以不需要?或是依舊保留,但多一個實際運行時的方式?
開發時例如etcd, mysql , mongo , redis ,kafka 等這種中間件服務,可以定義用 docker 去啟動
例如寄信,簡訊等要串三方的,我們其實不需要本地啟動,因為跟實際的使用案例不相符合,我們不會
自己去架設簡訊及寄信服務,大概率是依賴三方
更新文件,把啟動說明拆成兩段: production 與測試,production 用 docker 啟動,測試用 go run