AGENTS.md

1# AGENTS.md
2 
3## 專案概覽
4 
5這是一個用於教授初學者網頁開發基礎的教育課程儲存庫。該課程是由 Microsoft Cloud Advocates 開發的完整 12 週課程，包含 24 個涵蓋 JavaScript、CSS 和 HTML 的實作課程。
6 
7### 主要組成部分
8 
9- <strong>教育內容</strong>：24 個結構化課程，組成以專案為基礎的模組
10- <strong>實作專案</strong>：生態瓶、打字遊戲、瀏覽器擴充功能、太空遊戲、銀行應用、程式碼編輯器和 AI 聊天助理
11- <strong>互動測驗</strong>：48 個測驗，每個測驗包含 3 題（課前/課後評量）
12- <strong>多語言支援</strong>：透過 GitHub Actions 自動翻譯超過 50 種語言
13- <strong>技術堆疊</strong>：HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、Python（用於 AI 專案）
14 
15### 架構
16 
17- 教育儲存庫，採用以課程為基礎的結構
18- 每個課程資料夾包含 README、程式碼範例及解答
19- 獨立專案置於不同目錄（quiz-app、各種課程專案）
20- 透過 GitHub Actions (co-op-translator) 進行翻譯系統
21- 文件以 Docsify 提供，並可匯出為 PDF
22 
23## 安裝指令
24 
25此儲存庫主要用於教育內容的學習。若要操作特定專案：
26 
27### 主要儲存庫安裝
28 
29```bash
30git clone https://github.com/microsoft/Web-Dev-For-Beginners.git
31cd Web-Dev-For-Beginners
32```
33 
34### 測驗應用安裝 (Vue 3 + Vite)
35 
36```bash
37cd quiz-app
38npm install
39npm run dev        # 啟動開發伺服器
40npm run build      # 為生產環境建置
41npm run lint       # 執行 ESLint
42```
43 
44### 銀行專案 API (Node.js + Express)
45 
46```bash
47cd 7-bank-project/api
48npm install
49npm start          # 啟動 API 伺服器
50npm run lint       # 執行 ESLint
51npm run format     # 使用 Prettier 格式化
52```
53 
54### 瀏覽器擴充專案
55 
56```bash
57cd 5-browser-extension/solution
58npm install
59# 遵循瀏覽器特定的擴充功能載入說明
60```
61 
62### 太空遊戲專案
63 
64```bash
65cd 6-space-game/solution
66npm install
67# 在瀏覽器中開啟 index.html 或使用 Live Server
68```
69 
70### 聊天專案 (Python 後端)
71 
72```bash
73cd 9-chat-project/solution/backend/python
74pip install openai
75# 設定 GITHUB_TOKEN 環境變數
76python api.py
77```
78 
79## 開發工作流程
80 
81### 內容貢獻者
82 
831. **將儲存庫分支 (fork)** 至你的 GitHub 帳號
842. **在本機複製 (clone) 你的分支**
853. <strong>建立新分支</strong> 來進行修改
864. 修改課程內容或程式碼範例
875. 在相關專案目錄中測試程式碼變更
886. 按照貢獻指南提交 Pull Request
89 
90### 學習者
91 
921. 分支或複製儲存庫
932. 按順序瀏覽課程目錄
943. 閱讀各課程的 README 文件
954. 在 https://ff-quizzes.netlify.app/web/ 完成課前測驗
965. 在課程資料夾中練習程式碼範例
976. 完成作業與挑戰
987. 參加課後測驗
99 
100### 實時開發
101 
102- <strong>文件</strong>：於根目錄執行 `docsify serve`（預設端口 3000）
103- <strong>測驗應用</strong>：於 quiz-app 資料夾執行 `npm run dev`
104- <strong>專案</strong>：使用 VS Code Live Server 擴充功能提供 HTML 專案服務
105- **API 專案**：於相應 API 目錄執行 `npm start`
106 
107## 測試指令
108 
109### 測驗應用測試
110 
111```bash
112cd quiz-app
113npm run lint       # 檢查程式碼風格問題
114npm run build      # 確認建置成功
115```
116 
117### 銀行 API 測試
118 
119```bash
120cd 7-bank-project/api
121npm run lint       # 檢查程式碼風格問題
122node server.js     # 驗證伺服器是否無錯誤啟動
123```
124 
125### 一般測試方式
126 
127- 此為教育用儲存庫，不包含全面自動化測試
128- 以手動測試為主，重點為：
129  - 程式碼範例能正常執行無錯誤
130  - 文件中的連結有效
131  - 專案能成功編譯
132  - 範例遵循最佳實踐
133 
134### 提交前檢查
135 
136- 於含有 package.json 的目錄執行 `npm run lint`
137- 確認 markdown 連結正確
138- 在瀏覽器或 Node.js 中測試程式碼範例
139- 確保翻譯內容結構完整
140 
141## 程式碼風格指導
142 
143### JavaScript
144 
145- 使用現代 ES6+ 語法
146- 遵循專案內標準 ESLint 配置
147- 使用有意義的變數和函數名稱以利教學理解
148- 添加說明註解解釋概念給學習者
149- 配置 Prettier 的地方使用其格式化
150 
151### HTML/CSS
152 
153- 採用語意化的 HTML5 元素
154- 遵循響應式設計原則
155- 清晰的類別命名規範
156- 用註解解釋 CSS 技巧給學習者
157 
158### Python
159 
160- 遵循 PEP 8 風格規範
161- 清晰且具教育意義的程式碼範例
162- 適當使用型別註記方便學習
163 
164### Markdown 文件
165 
166- 清楚的標題層級
167- 含有語言指示的程式區塊
168- 附加資源連結
169- 在 `images/` 資料夾中的截圖與圖片
170- 針對圖片附加替代文字以利無障礙
171 
172### 檔案組織
173 
174- 課程依序編號（1-getting-started-lessons、2-js-basics 等）
175- 每個專案有 `solution/` 且通常有 `start/` 或 `your-work/` 目錄
176- 圖片儲存在課程專屬的 `images/` 資料夾中
177- 翻譯存放於 `translations/{language-code}/` 結構中
178 
179## 建置與部署
180 
181### 測驗應用部署 (Azure 靜態網站)
182 
183quiz-app 配置為 Azure 靜態網站部署：
184 
185```bash
186cd quiz-app
187npm run build      # 建立 dist/ 資料夾
188# 在推送至 main 分支時，透過 GitHub Actions 工作流程進行部署
189```
190 
191Azure 靜態網站配置：
192- <strong>應用位置</strong>：`/quiz-app`
193- <strong>輸出位置</strong>：`dist`
194- <strong>工作流程</strong>：`.github/workflows/azure-static-web-apps-ashy-river-0debb7803.yml`
195 
196### 文件 PDF 產生
197 
198```bash
199npm install                    # 安裝 docsify-to-pdf
200npm run convert               # 從 docs 產生 PDF
201```
202 
203### Docsify 文件
204 
205```bash
206npm install -g docsify-cli    # 全域安裝 Docsify
207docsify serve                 # 在 localhost:3000 提供服務
208```
209 
210### 專案建置
211 
212各專案目錄可能有獨立建置流程：
213- Vue 專案：使用 `npm run build` 產生生產包
214- 靜態專案：不需建置，直接提供檔案服務
215 
216## Pull Request 指南
217 
218### 標題格式
219 
220使用清晰且描述性標題指示修改範圍：
221- `[Quiz-app] 新增課程 X 測驗`
222- `[Lesson-3] 修正生態瓶專案錯字`
223- `[Translation] 新增課程 5 之西班牙文翻譯`
224- `[Docs] 更新安裝說明`
225 
226### 必要檢查
227 
228提交 PR 前：
229 
2301. <strong>程式碼品質</strong>：
231   - 在相關專案目錄執行 `npm run lint`
232   - 修正所有 lint 錯誤與警告
233 
2342. <strong>建置驗證</strong>：
235   - 如適用，執行 `npm run build`
236   - 確保無建置錯誤
237 
2383. <strong>連結校驗</strong>：
239   - 測試所有 markdown 連結
240   - 確認圖片引用有效
241 
2424. <strong>內容審核</strong>：
243   - 校對拼字與語法
244   - 確保程式碼範例正確且具教育意義
245   - 確認翻譯準確且保持原意
246 
247### 貢獻條件
248 
249- 同意 Microsoft CLA（首次 PR 自動檢查）
250- 遵循 [Microsoft 開源行為準則](https://opensource.microsoft.com/codeofconduct/)
251- 詳細指南見 [CONTRIBUTING.md](./CONTRIBUTING.md)
252- 如適用於 PR 描述中註明 issue 編號
253 
254### 審核程序
255 
256- PR 由維護者與社群審核
257- 優先考量教育清晰度
258- 程式碼範例應符合最佳實務
259- 翻譯審核確保準確且符合文化背景
260 
261## 翻譯系統
262 
263### 自動翻譯
264 
265- 透過 GitHub Actions 配合 co-op-translator 工作流程
266- 自動翻譯超過 50 種語言
267- 來源檔置於主要目錄中
268- 翻譯檔存於 `translations/{language-code}/` 目錄
269 
270### 手動翻譯改進
271 
2721. 定位於 `translations/{language-code}/` 中的檔案
2732. 進行改進並保留結構
2743. 確保程式碼範例依然可運作
2754. 測試任何本地化測驗內容
276 
277### 翻譯元資料
278 
279翻譯檔包含元資料標頭：
280```markdown
281<!--
282CO_OP_TRANSLATOR_METADATA:
283{
284  "original_hash": "...",
285  "translation_date": "...",
286  "source_file": "...",
287  "language_code": "..."
288}
289-->
290```
291 
292## 除錯與疑難排解
293 
294### 常見問題
295 
296<strong>測驗應用無法啟動</strong>：
297- 確認 Node.js 版本（建議 v14 以上）
298- 刪除 `node_modules` 和 `package-lock.json`，重新執行 `npm install`
299- 檢查端口是否衝突（預設 Vite 使用 5173 端口）
300 
301**API 伺服器無法啟動**：
302- 確認 Node.js 版本符合最低要求（node >=10）
303- 檢查該端口是否已被占用
304- 確保已執行 `npm install` 以安裝所有相依套件
305 
306<strong>瀏覽器擴充無法載入</strong>：
307- 確認 manifest.json 格式正確
308- 查看瀏覽器主控台有無錯誤訊息
309- 參考瀏覽器專屬擴充安裝說明
310 
311**Python 聊天專案問題**：
312- 確保安裝了 OpenAI 套件：`pip install openai`
313- 確認 GITHUB_TOKEN 環境變數已設定
314- 檢查 GitHub Models 訪問權限
315 
316**Docsify 無法提供文件服務**：
317- 全域安裝 docsify-cli：`npm install -g docsify-cli`
318- 從儲存庫根目錄執行
319- 確認存在 `docs/_sidebar.md`
320 
321### 開發環境建議
322 
323- 使用 VS Code 搭配 Live Server 擴充執行 HTML 專案
324- 安裝 ESLint 和 Prettier 擴充以維持格式一致
325- 利用瀏覽器開發者工具除錯 JavaScript
326- Vue 專案建議安裝 Vue DevTools 瀏覽器擴充
327 
328### 性能考量
329 
330- 多達 50 種語言之翻譯使完整克隆資料龐大
331- 僅編輯內容可使用淺層克隆：`git clone --depth 1`
332- 編輯英文內容時可排除翻譯搜尋
333- 第一次執行建置流程可能較慢（npm install、Vite build）
334 
335## 安全性考量
336 
337### 環境變數
338 
339- API 金鑰不可提交至儲存庫
340- 使用 `.env` 檔案（已列入 `.gitignore`）
341- 文件中說明所需環境變數
342 
343### Python 專案
344 
345- 使用虛擬環境：`python -m venv venv`
346- 持續更新相依套件
347- GitHub Token 需具最小必要權限
348 
349### GitHub Models 存取權限
350 
351- 使用個人存取權杖（PAT）
352- 將 Token 設為環境變數
353- 絕不提交 Token 或帳密
354 
355## 附加說明
356 
357### 目標對象
358 
359- 完全初學者的網頁開發學習者
360- 學生與自我學習者
361- 在教室使用課程的老師
362- 內容設計強調無障礙性及技能逐步建立
363 
364### 教育理念
365 
366- 以專案為基礎的學習方式
367- 頻繁的知識檢核（測驗）
368- 實作程式練習
369- 真實世界應用範例
370- 注重基礎概念，先於框架學習
371 
372### 儲存庫維護
373 
374- 積極的學習及貢獻社群
375- 定期更新相依套件與內容
376- 維護者監控議題與討論
377- 透過 GitHub Actions 自動化翻譯更新
378 
379### 相關資源
380 
381- [Microsoft Learn 模組](https://docs.microsoft.com/learn/)
382- [學生中心資源](https://docs.microsoft.com/learn/student-hub/)
383- 推薦學習者使用 [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
384- 其他課程：生成式 AI、資料科學、機器學習、物聯網課程
385 
386### 使用特定專案說明
387 
388個別專案詳細說明請參考：
389 
390- `quiz-app/README.md` - Vue 3 測驗應用
391- `7-bank-project/README.md` - 帶身份驗證的銀行應用
392- `5-browser-extension/README.md` - 瀏覽器擴充功能開發
393- `6-space-game/README.md` - Canvas 遊戲開發
394- `9-chat-project/README.md` - AI 聊天助理專案
395 
396### Monorepo 結構
397 
398雖非傳統 monorepo，此儲存庫包含多個獨立專案：
399 
400- 各課程自成一體
401- 專案間不共用相依套件
402- 可單獨工作不影響其他專案
403- 克隆整個儲存庫可獲得完整課程體驗
404 
405---
406 
407<!-- CO-OP TRANSLATOR DISCLAIMER START -->
408**免責聲明**：  
409本文件使用 AI 翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 進行翻譯。雖然我們努力追求準確性，但請注意，自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於關鍵資訊，建議採用專業人工翻譯。我們對因使用此翻譯而產生的任何誤解或誤釋概不負責。
410<!-- CO-OP TRANSLATOR DISCLAIMER END -->