/Multiplayer-Three-Gallery

Primary LanguageTypeScript

架構

File Structure

使用 turporepo 來實踐 monorepo 管理套件

/Project
|-- /.github
|-- /.husky
|-- /apps
| |-- /api
| |-- /web
|-- /packages
| |-- /common-type

說明

  • .github/：存放 github 的設定檔，包含 CICD 流程等等
  • .husky/：存放 git hook 的設定檔，也就是在 push 之前會執行的指令
  • apps/：存放所有應用程式
    • api/：存放主要掌管後端的 API Server
    • web/：存放主要掌管前端的 Web Server
  • packages/：存放所有共用的套件
    • common-type/：存放所有共用的型別定義

快樂大三專題 開發注意事項

1. git workflow

在目前的系統中，main branch 如果有任何 push，都會觸發自動部屬 也就是說如果程式碼有問題，會直接影響到線上的系統 如果各位在開發新功能時，可以照著以下流程進行

git checkout main # 切換到 main branch
git pull # 確保 local 的 main branch 是最新的版本
git checkout -b <branch_name> # 建立新的 branch 並切換到新的 branch
# 開始開發新功能
# 反覆的 add, commit，然後消滅 bug，直到功能完成

完成後，要來開 PR Pull Request，相當於向所有人告知你完成了某個功能，並且請大家來檢查你的程式碼

  1. 打開 Github 專案頁面 Alt text

  2. 點選 New pull request

Alt text 確認上方的 compare 是你剛剛開發的 branch，旁邊的 base 是 main branch

  1. 點選 Create pull request

  2. 輸入 PR 的標題和內容，並且點選 Create pull request

  3. 叫其他人幫你看 PR，如果確定沒問題，就可以點選 Merge pull request ，並且刪除這個 branch

如果要開發新的功能，請重複上述步驟

Install

  1. yarn
  2. yarn prepare to enable git hook

Running Developer Server

yarn dev or npm run dev

Running Production Server

yarn build and yarn start

Running Test

yarn test and yarn lint

Husky Git Hooks

為了保證程式碼安全，在 push 之前會先執行 yarn lint 和 yarn test，檢查全部程式碼是否正常，如果有錯誤，則會阻止 push 所以在遇到錯誤時，可以執行看看上面那兩個 Test 指令 並修正錯誤，才能 push