digimon/app-cloudep-notification-service
digimon
/
app-cloudep-notification-service
3
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

docs/update readme #8

Merged
daniel.w merged 2 commits from docs/update-readme into main 2024-10-29 06:03:37 +00:00
Conversation 3 Commits 2 Files Changed 1 +90
simon.yhh commented 2024-10-28 08:29:24 +00:00
Owner
Copy Link

更新 README

  1. 簡述專案架構、重點資料夾或檔案的功用
  2. 能夠在本地端啟動的教學
更新 README 1. 簡述專案架構、重點資料夾或檔案的功用 2. 能夠在本地端啟動的教學
simon.yhh added 1 commit 2024-10-28 08:29:25 +00:00
simon.yhh requested review from daniel.w 2024-10-28 08:30:05 +00:00
simon.yhh changed title from docs: update readme to docs/update readme 2024-10-28 08:33:19 +00:00
simon.yhh self-assigned this 2024-10-28 08:51:24 +00:00
daniel.w approved these changes 2024-10-29 05:28:57 +00:00
README.md
@ -0,0 +9,4 @@
```bash
cd app-cloudep-notification-service
go mod tidy
make gen-rpc
daniel.w commented 2024-10-29 03:44:41 +00:00
Owner
Copy Link

有產生過只要 proto 沒有變動並不需要再次gen

有產生過只要 proto 沒有變動並不需要再次gen
README.md
@ -0,0 +26,4 @@
```bash
brew install protobuf
```
- etcd (https://etcd.io/)
daniel.w commented 2024-10-29 03:45:34 +00:00
Owner
Copy Link

這邊可以討論，就是開發時可以用 docker 啟用，應該可以不用直接安裝本地依賴

這邊可以討論，就是開發時可以用 docker 啟用，應該可以不用直接安裝本地依賴
README.md
@ -0,0 +31,4 @@
brew install etcd
brew services start etcd
```
- SMTP 服務（以 mailhog 為例） (https://github.com/mailhog/MailHog)
daniel.w commented 2024-10-29 03:46:21 +00:00
Owner
Copy Link

SMTP 也是會直接依賴線上服務，除非有需要自己架設，但因為這個比較偏離 notification 的重點
比較偏好使用線上服務

SMTP 也是會直接依賴線上服務，除非有需要自己架設，但因為這個比較偏離 notification 的重點 比較偏好使用線上服務
simon.yhh commented 2024-10-29 05:33:37 +00:00
Author
Owner
Copy Link

可以討論一下 README 的格式跟內容，我是想說可以寫：

  1. 程式碼架構
  2. 本地啟動教學
    不過如果服務都是 docker 啟動、依賴線上服務的話，第二點似乎可以不需要？或是依舊保留，但多一個實際運行時的方式？
可以討論一下 README 的格式跟內容，我是想說可以寫： 1. 程式碼架構 2. 本地啟動教學 不過如果服務都是 docker 啟動、依賴線上服務的話，第二點似乎可以不需要？或是依舊保留，但多一個實際運行時的方式？
👍 1
daniel.w commented 2024-10-29 05:40:44 +00:00
Owner
Copy Link
  1. 程式碼架構很讚可以寫，更方便閱讀
  2. 啟動方式也可以寫或者可以把我們需要的一些 docker-file 放進去
    開發時例如etcd, mysql , mongo , redis ,kafka 等這種中間件服務，可以定義用 docker 去啟動
    例如寄信，簡訊等要串三方的，我們其實不需要本地啟動，因為跟實際的使用案例不相符合，我們不會
    自己去架設簡訊及寄信服務，大概率是依賴三方
1. 程式碼架構很讚可以寫，更方便閱讀 2. 啟動方式也可以寫或者可以把我們需要的一些 docker-file 放進去 開發時例如etcd, mysql , mongo , redis ,kafka 等這種中間件服務，可以定義用 docker 去啟動 例如寄信，簡訊等要串三方的，我們其實不需要本地啟動，因為跟實際的使用案例不相符合，我們不會 自己去架設簡訊及寄信服務，大概率是依賴三方
simon.yhh added 1 commit 2024-10-29 05:58:54 +00:00
simon.yhh commented 2024-10-29 05:59:43 +00:00
Author
Owner
Copy Link

更新文件，把啟動說明拆成兩段： production 與測試，production 用 docker 啟動，測試用 go run

更新文件，把啟動說明拆成兩段： production 與測試，production 用 docker 啟動，測試用 go run
daniel.w merged commit a4cec53aac into main 2024-10-29 06:03:37 +00:00
daniel.w referenced this issue from a commit 2024-10-29 06:03:38 +00:00
docs/update readme (#8)
Sign in to join this conversation.
Reviewers
No reviewers
daniel.w
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
simon.yhh
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: digimon/app-cloudep-notification-service#8
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?