跳到主要内容

啟動包

寫程式的環境

我們辦公室的大部分人都在虛擬機中進行編碼。您需要擁有一個 SSH 金鑰來進行連接。

您可以按照教程中的步驟來設置編碼環境：

通過這種方式，您可以在您喜歡的編輯器編寫代碼，保存文件，文件將同步到虛擬機器中，並實時重新加載以查看您的更改。

寫程式

我們的大多數項目都使用相同的技術和工具。

環境要求

*NIX 系統 (Unix / Linux, Posix, MacOS 等等...)
docker
docker-compose
make

新專案初始流程

git clone $repo
git checkout develop 我們並不是在 master branch 工作。請參考 gitflow ！
make init 初始化環境變數。
make 讓 the 服務在您電腦上進行(api + sql + phpmyadmin)
make logs 觀看 docker 的日誌

API development 模式 (make) 會觀察是否更新再自動重新啟動(感謝 Nodemon)

React / React-Native / Preact 已經有觀察更新的工具

Commit message

後端:

✨ :sparkles: 新增功能
♻️ :recycle: 重構程式碼
🚑 :ambulance: 緊急修復
🔥 :fire: 移除程式碼或檔案
🎨 :art: 改善程式碼結構或格式
⚡ :zap: 改善效能
✅ :white_check_mark: 新增或更新測試

Makefile

make help 觀看可利用的指令
make 啟動專案
make logs 專案日誌
make clean 停止專案

推薦的 VS Code 擴充程式

GitHub Copilot AI 自動完成程式碼
EditorConfig for VS Code 如果專案有設置.editorconfig, 可以更簡單的格式化程式碼
Error Lens 在行尾顯示錯誤
Git Graph 顯示專案 git 圖表
ESLint 幫助你寫出乾淨的程式碼
Import Cost 顯示導入套件的大小

Backend

Thunder Client 類似 Postman, 可以直接對 API 發出請求
Doxygen Documentation Generator 快速的產生 jsdoc
Gitmoji 用 gitmoji 來寫 commit message

若想了解更多的話，請參考寫程式的風格。

寫程式的環境
寫程式