chore(i18n): sync translations with latest source changes (chunk 1/1, 6 changes)

pull/1690/head
localizeflow[bot] 6 months ago
parent fae448befb
commit 98c1852d5b

@ -493,7 +493,7 @@
},
"AGENTS.md": {
"original_hash": "a362efd06d64d4134a0cfe8515a86d34",
"translation_date": "2026-02-06T07:55:59+00:00",
"translation_date": "2026-02-06T11:10:34+00:00",
"source_file": "AGENTS.md",
"language_code": "ja"
},

@ -2,46 +2,46 @@
## プロジェクト概要
これは初心者にウェブ開発の基礎を教えるための教育カリキュラムリポジトリです。カリキュラムはMicrosoft Cloud Advocatesによって開発された包括的な12週間のコースで、JavaScript、CSS、HTMLをカバーする24の実践的なレッスンで構成されています。
これは初心者に対してウェブ開発の基礎を教えるための教育カリキュラムリポジトリです。カリキュラムはMicrosoft Cloud Advocatesによって開発された包括的な12週間のコースで、JavaScript、CSS、HTMLをカバーする24の実践的なレッスンが含まれています。
### 主な構成要素
### 主要コンポーネント
- **教育コンテンツ**プロジェクトベースのモジュールに整理された24の構造化されたレッスン
- **実践プロジェクト**:テラリウム、タイピングゲーム、ブラウザ拡張機能、スペースゲーム、銀行アプリ、コードエディター、AIチャットアシスタント
- **インタラクティブクイズ**それぞれ3問の質問を含む48のクイズレッスン前後の評価
- **多言語サポート**GitHub Actionsを利用した50以上の言語への自動翻訳
- **実践プロジェクト**:テラリウム、タイピングゲーム、ブラウザー拡張機能、スペースゲーム、バンキングアプリ、コードエディタ、AIチャットアシスタント
- **インタラクティブクイズ**レッスン前後評価用の3問ずつ計48のクイズ
- **多言語対応**GitHub Actionsを用いた50以上の言語への自動翻訳
- **技術スタック**HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、PythonAIプロジェクト用
### アーキテクチャ
- レッスンベースの教育リポジトリ構造
- 各レッスンフォルダーにはREADME、コード例、解答例を含む
- 独立したプロジェクトは個別ディレクトリに配置quiz-app、各種レッスンプロジェクト
- GitHub Actionsを使用した翻訳システムco-op-translator
- Docsifyでドキュメントを配信し、PDFとしても利用可能
- レッスンベースの構造を持つ教育リポジトリ
- 各レッスンフォルダにはREADME、コード例、解答が含まれる
- quiz-appや他の様々なレッスンプロジェクトは独立したディレクトリ
- GitHub Actionsco-op-translatorを使った翻訳システム
- Docsifyによるドキュメント提供とPDF形式での利用可能
## セットアップコマンド
このリポジトリは主に教育コンテンツの利用を目的としています。特定プロジェクトで作業する場合:
### メインリポジトリセットアップ
### メインリポジトリセットアップ
```bash
git clone https://github.com/microsoft/Web-Dev-For-Beginners.git
cd Web-Dev-For-Beginners
```
### Quiz App セットアップ (Vue 3 + Vite)
### Quiz App セットアップVue 3 + Vite
```bash
cd quiz-app
npm install
npm run dev # 開発サーバーを起動する
npm run build # 本番用にビルドする
npm run lint # ESLintを実行する
npm run dev # 開発サーバーを起動
npm run build # 本番用にビルド
npm run lint # ESLint を実行
```
### 銀行プロジェクトAPI (Node.js + Express)
### バンクプロジェクト APINode.js + Express
```bash
cd 7-bank-project/api
@ -51,12 +51,12 @@ npm run lint # ESLintを実行する
npm run format # Prettierでフォーマットする
```
### ブラウザ拡張機能プロジェクト
### ブラウザ拡張プロジェクト
```bash
cd 5-browser-extension/solution
npm install
# ブラウザ固有の拡張機能の読み込み手順に従ってください
# ブラウザ固有の拡張機能の読み込み手順に従
```
### スペースゲームプロジェクト
@ -64,10 +64,10 @@ npm install
```bash
cd 6-space-game/solution
npm install
# index.html をブラウザで開くか、Live Server を使用してください
# index.htmlをブラウザで開くか、Live Serverを使用してください
```
### チャットプロジェクト (Pythonバックエンド)
### チャットプロジェクトPython バックエンド)
```bash
cd 9-chat-project/solution/backend/python
@ -78,43 +78,43 @@ python api.py
## 開発ワークフロー
### コンテンツ提供者向け
### コンテンツ寄稿者向け
1. GitHubアカウントにリポジトリを**フォーク**する
2. フォークしたリポジトリをローカルに**クローン**する
3. 変更用の**新しいブランチ**を作成する
4. レッスンコンテンツやコード例に変更を加え
5. 関連プロジェクトディレクトリでコード変更をテストする
6. 貢献ガイドラインに従いプルリクエストを提出す
1. リポジトリを自身のGitHubアカウントにフォークする
2. フォークをローカルにクローンする
3. 変更用の新しいブランチを作成する
4. レッスン内容やコード例を変更す
5. 関連するプロジェクトディレクトリでコード変更をテストする
6. コントリビューションガイドラインに従いプルリクエストを送
### 学習者向け
1. リポジトリをフォークまたはクローンする
2. レッスンディレクトリを順に進む
3. 各レッスンのREADMEファイルを読む
4. https://ff-quizzes.netlify.app/web/ でレッスン前クイズを完了する
5. レッスンフォルダ内のコード例に取り組む
6. 課題やチャレンジを完了する
7. レッスン後クイズを受ける
3. 各レッスンのREADMEを読む
4. https://ff-quizzes.netlify.app/web/ でレッスン前クイズを完了する
5. レッスンフォルダ内のコード例を実践する
6. 課題やチャレンジに取り組む
7. レッスン後クイズを受ける
### ライブ開発
- **ドキュメント**:ルートで `docsify serve` を実行 (ポート3000)
- **Quiz App**quiz-appディレクトリで `npm run dev` を実行
- **プロジェクト**HTMLプロジェクトはVS CodeのLive Server拡張機能を使
- **APIプロジェクト**該当のAPIディレクトリで `npm start` を実行
- **ドキュメンテーション**:リポジトリルートで `docsify serve` を実行ポート3000
- **クイズアプリ**quiz-appディレクトリで `npm run dev`
- **プロジェクト**HTMLプロジェクトはVS CodeのLive Server拡張を利
- **APIプロジェクト**各APIディレクトリで `npm start`
## テスト手順
### Quiz App テスト
### クイズアプリテスト
```bash
cd quiz-app
npm run lint # コードスタイルの問題を確認する
npm run lint # コードスタイルの問題をチェックする
npm run build # ビルドが成功することを確認する
```
### 銀行APIテスト
### バンクAPIテスト
```bash
cd 7-bank-project/api
@ -124,73 +124,73 @@ node server.js # サーバーがエラーなく起動することを確認
### 一般的なテスト方針
- 教育用リポジトリのため包括的な自動テストはなし
- 手動テストの重点
- コード例がエラーなく動作すること
- ドキュメント内のリンクが正しく機能すること
- 本リポジトリは包括的な自動テストはありません
- 手動テストでは以下を重視
- コード例がエラーなく実行されること
- ドキュメント内リンクが正しく動作すること
- プロジェクトのビルドが正常に完了すること
- 例がベストプラクティスに則っていること
- コード例がベストプラクティスに沿っていること
### 提出前チェック
### 提出前チェック
- package.jsonがあるディレクトリで `npm run lint` を実行
- Markdownリンクの有効性を確認
- ブラウザまたはNode.jsでコード例をテスト
- 翻訳が正しい構造を維持していることを確認
- マークダウンリンクの有効性を確認
- ブラウザNode.jsでコード例をテスト
- 翻訳が構造を保持していることをチェック
## コードスタイルガイドライン
### JavaScript
- 最新のES6+構文を使用
- プロジェクトで提供されている標準のESLint設定に従う
- 教育的な明快さのため意味のある変数名・関数名を使用
- 学習者のために概念を説明するコメントを追加
- 設定がある場合はPrettierでフォーマット
- モダンなES6+構文を使用
- 各プロジェクト提供の標準ESLint設定に準拠
- 教育的に分かりやすい意味のある変数名、関数名を使う
- 学習者向けに概念を説明するコメントを追加
- Prettierが設定されている場合は整形を行う
### HTML/CSS
- セマンティックなHTML5要素
- レスポンシブデザイン原則
- セマンティックなHTML5要素を使用
- レスポンシブデザイン原則を適用
- 明確なクラス命名規則
- 学習者向けのCSS技術を説明するコメント
- CSS技法を説明するコメントを記述
### Python
- PEP 8スタイルガイドラインに準拠
- 分かりやすく教育的なコード例
- 学習のために有用な場所には型ヒントを追加
- PEP 8スタイルガイドに従う
- 分かりやすい教育的コード例
- 学習の助けとなる型ヒントを適宜使用
### Markdownドキュメンテーション
### マークダウンドキュメント
- 明確な見出し階層
- 言語指定付きコードブロック
- 言語指定されたコードブロック
- 追加リソースへのリンク
- `images/`ディレクトリ内のスクリーンショット画像
- アクセシビリティのための画像の代替テキスト
- `images/` ディレクトリ内のスクリーンショット等の画像
- 画像にはアクセシビリティのための代替テキストを設定
### ファイル構成
- レッスンは番号順1-getting-started-lessons、2-js-basicsなど
- 各プロジェクトに `solution/` と通常は `start/` または `your-work/` ディレクトリあり
- 画像はレッスン固有`images/` フォルダに保存
- 翻訳ファイルは `translations/{language-code}/` 構造で管理
- レッスンは連番付き1-getting-started-lessons、2-js-basicsなど
- 各プロジェクトに`solution/` と多くは `start/``your-work/` ディレクトリを含む
- 画像はレッスン`images/` フォルダに保存
- 翻訳ファイルは `translations/{language-code}/` 構造で配置
## ビルドおよびデプロイ
## ビルドデプロイ
### Quiz Appのデプロイ (Azure Static Web Apps)
### クイズアプリのデプロイAzure Static Web Apps
quiz-appはAzure Static Web Appsに設定されています:
quiz-appはAzure Static Web Apps向けに設定されています:
```bash
cd quiz-app
npm run build # dist/ フォルダーを作成します
# main ブランチへのプッシュ時に GitHub Actions ワークフローを通じてデプロイします
# main ブランチへのプッシュ時に GitHub Actions ワークフローデプロイします
```
Azure Static Web Apps設定:
- **アプリ場所**`/quiz-app`
- **出力場所**`dist`
Azure Static Web Apps設定
- **アプリ位置**`/quiz-app`
- **出力位置**`dist`
- **ワークフロー**`.github/workflows/azure-static-web-apps-ashy-river-0debb7803.yml`
### ドキュメントPDF生成
@ -200,83 +200,83 @@ npm install # docsify-to-pdf をインストールする
npm run convert # docs から PDF を生成する
```
### Docsifyドキュメンテーション
### Docsifyドキュメン
```bash
npm install -g docsify-cli # Docsifyをグローバルにインストールする
docsify serve # localhost:3000でサーする
docsify serve # localhost:3000でサービスを提供する
```
### プロジェクト固有のビルド
### プロジェクトビルド
各プロジェクトディレクトリに独自のビルドプロセスがある場合
- Vueプロジェクト`npm run build` で本番用バンドルを作
- 静的プロジェクト:ビルドステップなし、ファイルを直接配信
各プロジェクトディレクトリには独自のビルド手順がある場合あり
- Vueプロジェクト`npm run build` でプロダクションバンドル生
- 静的プロジェクト:ビルド不要、ファイルを直接提供
## プルリクエストガイドライン
### タイトルフォーマット
### タイトル形式
変更箇所を示す明確で説明的なタイトルを使用:
- `[Quiz-app] レッスンXの新しいクイズ追加`
- `[Lesson-3] テラリウムプロジェクトのタイプミス修正`
- `[Translation] レッスン5のスペイン語翻訳追加`
明確で変更内容がわかるタイトルを使用:
- `[Quiz-app] レッスンXの新クイズ追加`
- `[Lesson-3] テラリウムプロジェクトの誤字修正`
- `[Translation] レッスン5のスペイン語翻訳追加`
- `[Docs] セットアップ手順の更新`
### 必須チェック
PR提出前に
PR提出前に以下を実行
1. **コード品質**
- 該当プロジェクトディレクトリで `npm run lint` 実行
- すべてのリンティングエラーと警告を修正
- 影響を受けるプロジェクトディレクトリで `npm run lint`
- すべての警告・エラーを修正
2. **ビルド確認**
- 必要に応じて `npm run build` 実行
2. **ビルド検証**
- 必要に応じて `npm run build`
- ビルドエラーがないことを確認
3. **リンク検証**
- すべてのMarkdownリンクをテスト
- 画像参照が機能することを確認
- 全マークダウンリンクの検証
- 画像参照の動作確認
4. **内容レビュー**
- スペルと文法の校正
- コード例が正しく教育目的に適していること
- 翻訳が原文の意味を維持していることを確認
4. **コンテンツレビュー**
- 誤字脱字の校正
- コード例が正確で教育的であること
- 翻訳が原文の意味を保っていること
### 貢献条件
### 寄稿条件
- Microsoft CLAに同意最初のPRで自動チェック
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)の遵守
- Microsoft CLAに同意初回PRで自動チェック
- [Microsoftオープンソース行動規範](https://opensource.microsoft.com/codeofconduct/)に従う
- 詳細は[CONTRIBUTING.md](./CONTRIBUTING.md)参照
- 該当する場合はPR説明にIssue番号を記載
- 可能であればPR説明に関連Issue番号を記載
### レビュー体制
### レビュー手順
- メンテナおよびコミュニティによるレビュー
- 教育的な明快さを優先
- コード例は現行のベストプラクティスに従うこと
- 翻訳は正確さと文化的適合性を持つか確認
- メンテナコミュニティによるレビュー
- 教育的明瞭性を重視
- コード例は最新のベストプラクティスに従うこと
- 翻訳は正確性と文化的適合性をチェック
## 翻訳システム
### 自動翻訳
- GitHub Actionsでco-op-translatorワークフローを利
- GitHub Actionsのco-op-translatorワークフローを使
- 50以上の言語に自動翻訳
- ソースファイルはメインディレクトリ内にあり
- 翻訳ファイルは `translations/{language-code}/`
- メインディレクトリのソースファイルを翻訳
- 翻訳ファイルは `translations/{language-code}/` ディレクトリに置かれる
### 手動での翻訳改善追加
### 手動による翻訳改善の追加
1. `translations/{language-code}/`内のファイルを見つける
2. 構造を維持しつつ改善を加える
3. コード例が動作し続けることを確認
4. ローカライズされたクイズコンテンツのテストを行う
1. `translations/{language-code}/` 内のファイルを見つける
2. 構造を保持しつつ改善を行う
3. コード例が動作する状態を維持
4. ローカライズされたクイズ内容もテスト
### 翻訳メタデータ
翻訳ファイルにはメタデータヘッダーを含む
翻訳ファイルにはメタデータヘッダーが含まれる
```markdown
<!--
CO_OP_TRANSLATOR_METADATA:
@ -293,116 +293,116 @@ CO_OP_TRANSLATOR_METADATA:
### よくある問題
**Quizアプリが起動しない**
**クイズアプリが起動しない**
- Node.jsのバージョンを確認v14以上推奨
- `node_modules``package-lock.json` を削除し、`npm install` を再実行
- ポートの競合を確認デフォルトViteはポート5173使用
- `node_modules``package-lock.json` を削除し、再度 `npm install` 実行
- ポート競合を確認デフォルトはViteの5173番
**APIサーバーが起動しない**
- Node.jsのバージョンが要件を満たしているか確認node >=10
- ポートがすでに使用されていないかチェック
- すべての依存関係が `npm install` でインストールされているか確認
- Node.jsのバージョンが最低限(node >=10)を満たすか確認
- ポート利用状況をチェック
- `npm install`依存関係が全てインストールされているか確認
**ブラウザ拡張機能が読み込まれない**
- manifest.json のフォーマットが正しいか確認
- ブラウザコンソールのエラーをチェック
- ブラウザ固有の拡張機能インストール手順に従う
**ブラウザ拡張機能が読み込まれない**
- manifest.jsonのフォーマットを確認
- ブラウザのコンソールログでエラーを調査
- ブラウザ固有の拡張機能インストール手順を確認
**Pythonチャットプロジェクトの問題**
- OpenAIパッケージがインストールされているか確認`pip install openai`
- OpenAIパッケージがインストールされているか `pip install openai`
- GITHUB_TOKEN環境変数が設定されているか確認
- GitHub Modelsへのアクセス権をチェック
- GitHub Modelsへのアクセス権をチェック
**Docsifyがドキュメントを配信しない**
- docsify-cliをグローバルにインストール:`npm install -g docsify-cli`
- リポジトリのルートディレクトリから実行
- `docs/_sidebar.md` が存在するか確認
**Docsifyがドキュメントを提供しない**
- docsify-cliがグローバルにインストールされているか: `npm install -g docsify-cli`
- リポジトリルートで実行しているか確認
- `docs/_sidebar.md` が存在するかチェック
### 開発環境のポイント
### 開発環境のント
- HTMLプロジェクトにはVS CodeのLive Server拡張を利
- 一貫したフォーマットのためESLintとPrettier拡張をインストール
- JavaScriptのデバッグにはブラウザの開発者ツールを使
- VueプロジェクトにはVue DevToolsブラウザ拡張をインストール
- HTMLプロジェクトではVS CodeのLive Server拡張を使
- 一貫した整形のためESLintとPrettier拡張をインストール
- JavaScriptのデバッグにはブラウザのDevToolsを利
- VueプロジェクトではVue DevToolsブラウザ拡張を入れる
### パフォーマンス上の考慮
### パフォーマンスの注意
- 50以上の言語の翻訳ファイルがあるため、完全クローンはサイズが大きい
- コンテンツのみ作業する場合は浅いクローンを利用:`git clone --depth 1`
- 英語コンテンツ作業時は翻訳を検索から除外
- 初回実行時のビルドプロセスは遅い可能性ありnpm install、Viteビルド
- 50以上の言語の翻訳ファイルが多いため完全クローンは大容量
- コンテンツ作業のみなら浅いクローンを利用: `git clone --depth 1`
- 英語コンテンツ作業時は翻訳を検索から除外推奨
- npm installやViteビルドは初回が遅い可能性がある
## セキュリティに関する注意事項
## セキュリティの注意点
### 環境変数
- APIキーをリポジトリに絶対コミットしない
- `.env`ファイルを使用(既に`.gitignore`に追加済み
- 必要な環境変数はプロジェクトのREADMEに記載
- APIキーをリポジトリにコミットしないこと
- `.env` ファイルを使用(.gitignoreに含まれている
- 必要な環境変数は各プロジェクトのREADMEでドキュメント化
### Pythonプロジェクト
- 仮想環境を使用:`python -m venv venv`
- 依存関係常に最新に保つ
- GitHubトークンは必要最低限の権限を付与する
- 仮想環境を使用: `python -m venv venv`
- 依存関係常に最新に保つ
- GitHubトークンは必要最小限の権限に設定する
### GitHub Models アクセス
### GitHub Modelsアクセス
- パーソナルアクセストークンPATが必要
- トークンは環境変数として管
- トークンや資格情報を絶対にコミットしない
- GitHub ModelsにはパーソナルアクセストークンPATが必要
- トークンは環境変数として
- トークンや認証情報は決してコミットしない
## 追加の注意事項
## 追加ノート
### 対象ユーザー
- ウェブ開発初心者全般
- 学生や独学者
- 教育現場でカリキュラムを使う教師
- コンテンツはアクセシビリティと段階的なスキル習得を考慮して設計
- ウェブ開発の完全な初心者
- 学習者や自学者
- 教でカリキュラムを使う教師
- アクセシビリティと段階的スキル向上を意識したコンテンツ設計
### 教育哲学
### 教育方針
- プロジェクトベースの学習アプローチ
- 頻繁な知識チェック(クイズ)
- 頻繁な知識確認(クイズ)
- 実践的なコーディング演習
- 実世界の応用例
- フレームワークより基礎の習得に重点
- 実世界の応用例
- フレームワーク前の基礎重視
### リポジトリのメンテナンス
### リポジトリ運用
- 学習者と貢献者の活発なコミュニティ
- 依存関係とコンテンツの定期的な更新
- メンテナによるIssueやディスカッションの監視
- GitHub Actionsを介した自動翻訳更新
- 活発な学習者と寄稿者コミュニティ
- 依存関係やコンテンツは定期的に更新
- メンテナによる問題監視と議論管理
- 翻訳の更新はGitHub Actionsで自動化
### 関連リソース
- [Microsoft Learn モジュール](https://docs.microsoft.com/learn/)
- [Student Hub リソース](https://docs.microsoft.com/learn/student-hub/)
- 学習者向けに推奨される[GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
- 追加コース生成AI、データサイエンス、ML、IoTカリキュラムあり
- [Student Hubリソース](https://docs.microsoft.com/learn/student-hub/)
- 学習者に推奨される[GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
- 他のコース生成AI、データサイエンス、機械学習、IoTカリキュラムも利用可能
### プロジェクトの作業方法
### 特定プロジェクトの作業方法
個別プロジェクトの詳細な手順は以下のREADMEを参照
プロジェクトの詳細な手順は以下のREADMEを参照
- `quiz-app/README.md` - Vue 3クイズアプリケーション
- `7-bank-project/README.md` - 認証付き銀行アプリ
- `5-browser-extension/README.md` - ブラウザ拡張機能開発
- `7-bank-project/README.md` - 認証付きバンキングアプリ
- `5-browser-extension/README.md` - ブラウザ拡張開発
- `6-space-game/README.md` - Canvasベースゲーム開発
- `9-chat-project/README.md` - AIチャットアシスタント
- `9-chat-project/README.md` - AIチャットアシスタントプロジェクト
### モノレポ構造について
### モノレポ構
従来型のモノレポではありませんが、このリポジトリは複数の独立したプロジェクトを含みます:
- 各レッスンは自己完結型
- プロジェクト間で依存関係は共有しない
- 個別プロジェクトに影響なく作業可能
- フルカリキュラム体験のためにリポジトリ全体をクローン推奨
伝統的なモノレポではありませんが複数の独立プロジェクトを含みます:
- 各レッスンは独立済み
- プロジェクト間で依存関係共有なし
- 個別プロジェクトの作業が他に影響を与えない
- フルカリキュラム体験のためには全リポジトリのクローン推奨
---
<!-- CO-OP TRANSLATOR DISCLAIMER START -->
**免責事項**
本書類はAI翻訳サービスCo-op Translator(https://github.com/Azure/co-op-translator)を使用して翻訳されました。正確性を期していますが、自動翻訳には誤りや不正確な部分が含まれる場合があります。原文の言語による文書が権威ある情報源とみなされるべきです。重要な情報については、専門の翻訳者による翻訳を推奨します。本翻訳の利用により生じた誤解や解釈違いについて、一切の責任を負いかねます。
本書類はAI翻訳サービス[Co-op Translator](https://github.com/Azure/co-op-translator)を使用して翻訳されています。正確さを目指しておりますが、自動翻訳には誤りや不正確な部分が含まれる可能性があることをご留意ください。原文が権威ある情報源として優先されるべきです。重要な情報につきましては、専門の人間による翻訳を推奨します。本翻訳の利用により発生した誤解や誤訳について、当方は一切の責任を負いかねます。
<!-- CO-OP TRANSLATOR DISCLAIMER END -->

@ -493,7 +493,7 @@
},
"AGENTS.md": {
"original_hash": "a362efd06d64d4134a0cfe8515a86d34",
"translation_date": "2026-02-06T07:53:18+00:00",
"translation_date": "2026-02-06T11:08:07+00:00",
"source_file": "AGENTS.md",
"language_code": "zh-HK"
},

@ -2,42 +2,42 @@
## 專案概述
這是一個用於教導初學者網頁開發基礎的教育課程資源庫。此課程是一個完整的為期12週的課程由 Microsoft Cloud Advocates 開發包含24個實作課程涵蓋 JavaScript、CSS 和 HTML。
這是一個用於教導初學者網頁開發基礎的教育課程資源庫。課程為為期12週的完整課程由微軟雲端倡導者開發包含24堂實作課程涵蓋 JavaScript、CSS 與 HTML。
### 主要組成部分
- **教育內容**24 個有結構的課程,按專案模組組織
- **實作專案**:溫室、打字遊戲、瀏覽器擴充功能、太空遊戲、銀行應用、程式碼編輯器和 AI 聊天助理
- **互動測驗**48 組測驗每組有3題課前/課後評估)
- **多語言支援**:透過 GitHub Actions 自動翻譯超過50種語言
- **技術堆疊**HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、Python用於 AI 專案)
- **教育內容**24堂結構化課程,依專案模組編排
- **實作專案**:溫室、打字遊戲、瀏覽器擴充功能、太空遊戲、銀行應用、程式碼編輯器與 AI 聊天助手
- **互動測驗**48組測驗每組3題課前課後評估)
- **多語言支援**:透過 GitHub Actions 自動翻譯超過50種語言
- **技術使用**HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、PythonAI 專案)
### 架構
- 以課程為基礎的教育資源庫
- 每個課程資料夾包含 README、程式碼範例及解答
- 獨立專案位於不同目錄中quiz-app、各種課程專案)
- 使用 GitHub Actions (co-op-translator) 進行翻譯系統
- 文件使用 Docsify 發佈並提供 PDF 版本
- 以課程為架構的教育資源庫
- 每堂課資料夾包含說明文件、程式碼範例與解答
- 獨立專案置於獨立目錄中quiz-app、各堂專案)
- 使用 GitHub Actionsco-op-translator進行翻譯系統
- 文件以 Docsify 呈現,並提供 PDF 格式
## 設定指令
## 安裝指令
此資源庫主要供教育內容學習使用。若要操作特定專案:
此資源庫主要用作教育內容閱讀。若需使用特定專案:
### 主要資源庫設定
### 主要資源庫安裝
```bash
git clone https://github.com/microsoft/Web-Dev-For-Beginners.git
cd Web-Dev-For-Beginners
```
### 測驗應用程式設定Vue 3 + Vite
### 測驗應用安裝Vue 3 + Vite
```bash
cd quiz-app
npm install
npm run dev # 啟動開發伺服器
npm run build # 構建生產環境
npm run build # 建立生產版本
npm run lint # 執行 ESLint
```
@ -48,7 +48,7 @@ cd 7-bank-project/api
npm install
npm start # 啟動 API 伺服器
npm run lint # 執行 ESLint
npm run format # 用 Prettier 格式化
npm run format # 使用 Prettier 格式化
```
### 瀏覽器擴充功能專案
@ -56,7 +56,7 @@ npm run format # 用 Prettier 格式化
```bash
cd 5-browser-extension/solution
npm install
# 遵循瀏覽器特定的擴充功能載入指示
# 遵循瀏覽器專用的擴充功能載入指示
```
### 太空遊戲專案
@ -72,132 +72,132 @@ npm install
```bash
cd 9-chat-project/solution/backend/python
pip install openai
# 設置 GITHUB_TOKEN 環境變量
# 設定 GITHUB_TOKEN 環境變數
python api.py
```
## 開發工作流程
### 內容貢獻者指南
### 內容貢獻者
1. **分支複製fork** 本資源庫至你的 GitHub 帳號
2. **本地複製clone** 你的分支
3. **建立新分支** 進行修改
4. 編輯課程內容或程式碼範例
5. 在相關專案資料夾測試程式碼變更
6. 按貢獻指南提交拉取請求pull request
1. **Fork 本資源庫**到您的 GitHub 帳戶
2. **在本機 Clone 您的 Fork**
3. **建立新分支**以便進行修改
4. 修改課程內容或程式碼範例
5. 在相關專案資料夾測試程式碼修改
6. 依照貢獻指南提交 Pull Request
### 學習者指南
### 學習者
1. Fork 或 Clone 資源庫
2. 依序瀏覽課程目錄
3. 閱讀每課的 README 檔案
4. 完成 https://ff-quizzes.netlify.app/web/ 課前測驗
5. 操作課程資料夾中的程式碼範例
6. 完成作業和挑戰
2. 按順序瀏覽各課程資料夾
3. 閱讀每課的 README 檔案
4. 完成 https://ff-quizzes.netlify.app/web/ 課前測驗
5. 實作課程資料夾內的程式碼範例
6. 完成作業與挑戰任務
7. 參加課後測驗
### 時開發
### 時開發
- **文件**:於根目錄執行 `docsify serve`(埠號 3000
- **測驗應用程式**:於 quiz-app 目錄執行 `npm run dev`
- **專案**:使用 VS Code Live Server 外掛處理 HTML 專案
- **API 專案**於對應 API 目錄內執行 `npm start`
- **文件服務**:在根目錄執行 `docsify serve`(使用 3000 埠
- **測驗應用**:於 quiz-app 目錄執行 `npm run dev`
- **專案**靜態 HTML 項目可使用 VS Code Live Server 外掛
- **API 專案**分別目錄中執行 `npm start`
## 測試指南
## 測試說明
### 測驗應用程式測試
### 測驗應用測試
```bash
cd quiz-app
npm run lint # 檢查代碼風格問題
npm run build # 驗證構建成功
npm run build # 確認編譯成功
```
### 銀行 API 測試
```bash
cd 7-bank-project/api
npm run lint # 檢查程式碼風格問題
node server.js # 確認伺服器啟動時沒有錯誤
npm run lint # 檢查碼風格問題
node server.js # 驗證伺服器啟動時無錯誤
```
### 一般測試方法
### 一般測試流程
- 此為教育資源庫,未設全面自動化測試
- 手動測試重點:
- 程式碼範例無錯誤
- 文件內連結正確
- 專案可成功建置
- 範例符合最佳實踐
- 此為教育用資源庫,無全面自動化測試
- 手動測試重點
- 程式碼範例無錯誤
- 文件中連結均可正常運作
- 專案成功 build
- 範例遵守最佳實務
### 送出前檢查
### 提交前檢查項目
- 於含 package.json 資料夾執行 `npm run lint`
- 確認 markdown 連結有效
- 在瀏覽器或 Node.js 測試程式碼範例
- 檢查翻譯是否保有原有結構
- 在有 package.json 目錄下執行 `npm run lint`
- 驗證 markdown 鏈接有效
- 在瀏覽器或 Node.js 測試程式碼範例
- 確保翻譯內容維持正確結構
## 程式碼風格指
## 程式碼風格指
### JavaScript
- 使用現代 ES6+ 語法
- 遵循專案中的標準 ESLint 設定
- 為教育清晰使用具意義的變數、函式名稱
- 添加注釋說明概念,方便學習
- 在配置 Prettier 的地方使用格式化
- 遵循專案內提供的標準 ESLint 配置
- 使用具意義變數與函式命名以利教學理解
- 添加注釋以講解概念給學習者
- 透過 Prettier 格式化(若已配置)
### HTML/CSS
- 使用語化 HTML5 元素
- 使用語化 HTML5 元素
- 採用響應式設計原則
- 明確的類別命名規範
- 添加解釋 CSS 技巧的注釋
- 清晰的 class 命名規範
- 添加 CSS 技巧說明注釋以利學習者
### Python
- 遵循 PEP 8 風格指南
- 清晰且具有教育意義的程式碼範例
- 在有助於學習處添加型別提示
- 遵守 PEP 8 標準
- 清楚且具教學意義的程式碼範例
- 在適用處添加型別提示協助學習
### Markdown 文件
- 清楚的標題階層結構
- 含語言標示的程式碼區塊
- 連結至額外資源
- 使用 `images/` 目錄下的截圖及圖片
- 圖片含有替代文字以兼顧無障礙
- 清晰的標題層級
- 帶語言標識的程式碼區塊
- 附上額外資源連結
- `images/` 資料夾中的截圖與圖片
- 圖片備註文字以改善無障礙
### 檔案組織
- 課程依序編號1-getting-started-lessons、2-js-basics 等)
- 每專案通常含有 `solution/` `start/``your-work/` 目錄
- 圖片存放於課程專屬`images/` 資料夾
- 翻譯檔存於 `translations/{language-code}/` 架構中
- 專案中常有 `solution/` `start/``your-work/` 目錄
- 圖片存放於對應課程的 `images/` 資料夾
- 翻譯位於 `translations/{language-code}/` 結構
## 建置與部署
### 測驗應用程式部署Azure Static Web Apps
### 測驗 App 部署Azure Static Web Apps
quiz-app 已設定用於 Azure Static Web Apps 部署:
quiz-app 已配置用於 Azure Static Web Apps 部署:
```bash
cd quiz-app
npm run build # 建立 dist/ 資料夾
# 在推送到 main 時,透過 GitHub Actions 工作流程部署
# 在推送至主分支時透過 GitHub Actions 工作流程部署
```
Azure Static Web Apps 配置:
- **應用程式路徑**`/quiz-app`
- **輸出路徑**`dist`
- **App 位置**`/quiz-app`
- **輸出目錄**`dist`
- **工作流程**`.github/workflows/azure-static-web-apps-ashy-river-0debb7803.yml`
### 文件 PDF 產生
```bash
npm install # 安裝 docsify-to-pdf
npm run convert # 從 docs 生 PDF
npm run convert # 從 docs 生 PDF
```
### Docsify 文件
@ -207,76 +207,76 @@ npm install -g docsify-cli # 全域安裝 Docsify
docsify serve # 在 localhost:3000 提供服務
```
### 專案專屬建置
### 專案特定建置
各專案資料夾可能有自行建置流程:
- Vue 專案:`npm run build` 產生正式
- 靜態專案:無建置步驟,直接提供檔案
每個專案目錄可能有獨立建置流程:
- Vue 專案:`npm run build` 產生生產
- 靜態專案:無建置步驟,直接提供靜態檔案
## 拉取請求指南
## Pull Request 準則
### 標題格式
使用明確描述變更範圍的標題
- `[Quiz-app] 新增第 X 課測驗`
使用明確、描述性標題說明變更領域
- `[Quiz-app] 新增第X堂課測驗`
- `[Lesson-3] 修正溫室專案錯字`
- `[Translation] 新增第 5 课西班牙語翻譯`
- `[Docs] 更新設定說明`
- `[Translation] 新增第5課西班牙語翻譯`
- `[Docs] 更新安裝說明`
### 必要檢查
提交 PR 前:
1. **程式碼品質**
- 於受影響的專案資料夾執行 `npm run lint`
- 修正所有錯誤與警告
- 於受影響的專案目錄跑 `npm run lint`
- 修正所有 lint 錯誤與警告
2. **建置驗證**
- 如適用執行 `npm run build`
- 若有,執行 `npm run build`
- 確認無建置錯誤
3. **連結驗證**
- 測試所有 markdown 連結
- 確圖片引用正確
- 確圖片引用正確
4. **內容審**
- 校對拼寫文法
- 保證程式碼範例正確且具教育意義
- 確認翻譯維持原意
4. **內容審**
- 校對拼寫文法
- 確保程式碼範例正確且具教學價值
- 核對翻譯內容忠實原意
### 貢獻規範
### 貢獻要求
- 同意 Microsoft CLA第一個 PR 自動檢查)
- 遵守 [Microsoft 開源行為守則](https://opensource.microsoft.com/codeofconduct/)
- 詳細指南請參考 [CONTRIBUTING.md](./CONTRIBUTING.md)
- PR 描述中如適用請附上相關議題編號
- 同意微軟 CLA首次 PR 會自動檢查)
- 遵守 [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- 詳 [CONTRIBUTING.md](./CONTRIBUTING.md)
- 如適用,在 PR 描述中引用 issue 編號
### 審核流程
### 審查機制
- 維護者及社群會審核 PR
- 重視教育清晰度
- 程式碼範例應符合現有最佳實踐
- 翻譯需審核語意正確及文化合宜
- PR 將由維護者及社群檢視
- 優先考慮教育清晰度
- 程式碼範例應符合現行最佳實務
- 翻譯檢視準確性與文化適切性
## 翻譯系統
### 自動翻譯
### 自動翻譯
- 使用 GitHub Actions 與 co-op-translator 工作流程
- 自動翻譯超過50種語言
- 原始檔於主要目錄
- 翻譯檔存於 `translations/{language-code}/`
- 自動翻譯超過 50 種語言
- 原始檔於主要目錄
- 翻譯檔`translations/{language-code}/` 目錄
### 加入人工翻譯改進
### 手動翻譯改良
1. 尋找 `translations/{language-code}/` 內對應檔案
2. 在保有結構的前提下進行修訂
3. 確保程式碼範例依然可用
4. 測試地化測驗內容
1. 定位於 `translations/{language-code}/` 中的檔案
2. 在維持結構的條件下進行改善
3. 確保程式碼範例仍可正常運作
4. 測試地化測驗內容
### 翻譯元資料
翻譯檔含元資料標頭:
翻譯檔含元資料標頭:
```markdown
<!--
CO_OP_TRANSLATOR_METADATA:
@ -293,116 +293,116 @@ CO_OP_TRANSLATOR_METADATA:
### 常見問題
**測驗應用程式無法啟動**
- 檢查 Node.js 版本(建議 v14 以上
**測驗應用啟動失敗**
- 檢查 Node.js 版本(建議 v14+
- 刪除 `node_modules``package-lock.json`,重新執行 `npm install`
- 檢查埠號衝突預設Vite 使用 5173 埠)
**API 伺服器無法啟動**
- 確認 Node.js 版本符合最低node >=10
- 確認埠號未被占
- 確保所有相依性已用 `npm install` 安裝完成
- 確認 Node.js 版本符合最低node >=10
- 確認埠號是否被佔
- 確保所有相依套件已執行 `npm install`
**瀏覽器擴充功能不載入**
**瀏覽器擴充無法載入**
- 確認 manifest.json 格式正確
- 查瀏覽器控台錯誤訊息
- 遵循瀏覽器專屬擴充功能安裝說明
- 查瀏覽器控台錯誤訊息
- 依照瀏覽器特定的安裝說明操作
**Python 聊天專案問題**
- 確認已安裝 OpenAI 套件:`pip install openai`
- 確認 GITHUB_TOKEN 環境變數已設定
- 檢查 GitHub Models 存取權限
- 確認 OpenAI 套件安裝`pip install openai`
- 檢查 GITHUB_TOKEN 環境變數設置
- 確認具備 GitHub Models 存取權限
**Docsify 文件無法服務**
**Docsify 無法提供文件**
- 全域安裝 docsify-cli`npm install -g docsify-cli`
- 從資源庫根目錄啟動
- 確認 `docs/_sidebar.md` 存在
- 從資源庫根目錄執行
- 確認存在 `docs/_sidebar.md` 檔案
### 開發環境建議
- 使用 VS Code 與 Live Server 外掛處理 HTML 專案
- 安裝 ESLint 與 Prettier 外掛保持格式一致
- 使用瀏覽器開發工具除錯 JavaScript
- Vue 專案可安裝 Vue DevTools 瀏覽器擴充功能
- HTML 專案使用 VS Code 與 Live Server 擴充套件
- 安裝 ESLint 與 Prettier 擴充以維持格式一致
- 使用瀏覽器 DevTools 除錯 JavaScript
- Vue 專案可安裝 Vue DevTools 瀏覽器擴充
### 效能考量
- 多達50多種語言的翻譯檔案會造成完整複製資料庫龐
- 若只處理內容,可使用淺複製`git clone --depth 1`
- 在處理英文內容時排除翻譯資料夾搜尋
- 初次執行建置流程可能較慢npm install、Vite build
- 超過 50 種語言翻譯檔數量龐大,完整 clone 容量
- 只工作於內容時可用淺層 clone`git clone --depth 1`
- 編輯英文內容時可排除搜尋翻譯檔
- 建置流程首次執行時可能較慢npm install、Vite build
## 安全考量
## 安全考量
### 環境變數
- API 密鑰嚴禁提交至資源庫
- 使用 `.env` 檔(已加入 `.gitignore`
- 於專案 README 中記錄必要環境變數
- API 金鑰絕不可提交至資源庫
- 使用 `.env` 文件(已包含於 `.gitignore`
- 在專案 README 中說明必需之環境變數
### Python 專案
- 使用虛擬環境:`python -m venv venv`
- 持依套件更新
- GitHub 訪問代幣應具備最小必要權限
- 持續更新相依套件
- GitHub Token 應有最小必要權限
### GitHub Models 存取
- 需要個人存取權杖PAT
- 代幣應妥善存放為環境變數
- 禁止提交代幣或憑證
- 使用個人存取權杖PAT以存取 GitHub Models
- 將 Token 儲存為環境變數
- 切勿提交 Token 或憑證
## 附加說明
## 額外說明
### 目標受眾
- 網頁開發完全初學
- 學生自學者
- 教師用於班級教學
- 內容設計兼顧無障礙與逐步技能養成
- 對網頁開發全然新手
- 學生自學者
- 使用課程於教室教學的老師
- 內容設計以無障礙與技能循序漸進為主
### 教理念
### 教理念
- 專案導向學習
- 經常性知識檢核(測驗)
- 實作程式練習
- 專案導向學習
- 頻繁知識檢核(測驗)
- 實作編碼練習
- 真實世界應用範例
- 聚焦基礎,再談框架
- 強調基礎先於框架
### 資源庫維護
- 活躍學習者與貢獻社群
- 定期更新依賴套件和內容
- 維護者監控議題與討論
- 翻譯更新自動化透過 GitHub Actions
- 活躍學習者與貢獻社群
- 定期更新相依套件與內容
- 維護者監督問題及討論
- 透過 GitHub Actions 自動化翻譯更新
### 相關資源
- [Microsoft Learn 模組](https://docs.microsoft.com/learn/)
- [學生中心資源](https://docs.microsoft.com/learn/student-hub/)
- 推薦學習者使用 [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
- 其他課程:生成式 AI、數據科學、機器學習、物聯網課程
- 推薦使用 [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) 予學習者
- 另有生成式 AI、資料科學、機器學習、物聯網等課程可參考
### 專案操作說明
### 使用特定專案說明
個別專案詳細指南請參考 README 檔案
- `quiz-app/README.md` - Vue 3 測驗應用程式
- `7-bank-project/README.md` - 帶身份驗證的銀行應用程式
- `5-browser-extension/README.md` - 瀏覽器擴充功能開發
- `6-space-game/README.md` - Canvas 遊戲開發
- `9-chat-project/README.md` - AI 聊天助專案
詳細指引請參考 README
- `quiz-app/README.md` - Vue 3 測驗應用
- `7-bank-project/README.md` - 含認證的銀行應用
- `5-browser-extension/README.md` - 瀏覽器擴充開發
- `6-space-game/README.md` - Canvas 基礎遊戲
- `9-chat-project/README.md` - AI 聊天助專案
### Monorepo 結構
資源庫非傳統 monorepo但包含多個獨立專案
- 每課程獨自成章
- 專案不共用依賴
- 可獨立操作各專案不互相影響
- 如需完整課程體驗請 clone 整個資源庫
此非傳統 monorepo但包含多個獨立專案
- 每堂課自主完整
- 各專案無相依共享
- 可專注於單一專案開發
- 若要完整體驗請 clone 整個資源庫
---
<!-- CO-OP TRANSLATOR DISCLAIMER START -->
**免責聲明**
本文件使用 AI 翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 進行翻譯。雖然我們致力於準確性,但請注意,自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於重要資訊,建議尋求專業人工翻譯。我們對因使用本翻譯而引起的任何誤解或誤釋不承擔任何責任。
**免責聲明**
本文件係使用人工智能翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 進行翻譯。雖然我們努力確保準確性,但請注意,自動翻譯可能包含錯誤或不準確之處。原始文件以其原文為最具權威之版本。對於重要資訊,建議聘用專業人工翻譯。我們不對因使用此翻譯而產生的任何誤解或誤譯承擔責任。
<!-- CO-OP TRANSLATOR DISCLAIMER END -->

@ -493,7 +493,7 @@
},
"AGENTS.md": {
"original_hash": "a362efd06d64d4134a0cfe8515a86d34",
"translation_date": "2026-02-06T07:54:41+00:00",
"translation_date": "2026-02-06T11:09:15+00:00",
"source_file": "AGENTS.md",
"language_code": "zh-TW"
},

@ -1,43 +1,43 @@
# AGENTS.md
## 專案概
## 專案概
這是一個用於教導初學者網頁開發基礎的教育課程資源庫。課程為微軟雲端推廣者所開發的12週完整課程包含24個涵蓋 JavaScript、CSS 和 HTML 的實作課程
這是一個教育課程資源庫,旨在教授初學者網頁開發基礎。該課程是由 Microsoft Cloud Advocates 開發的完整 12 週課程,包含 24 個實作課程,涵蓋 JavaScript、CSS 和 HTML
### 主要組成部分
### 主要組
- **教育內容**24堂結構化課程,以專案為基礎的模組安排
- **務專案**:溫室生態缸、打字遊戲、瀏覽器擴充套件、太空遊戲、銀行應用程式、程式碼編輯器及 AI 聊天助手
- **互動測驗**48次測驗每次3題課前/課後評量
- **多語言支援**:透過 GitHub Actions 自動翻譯超過50種語言
- **技術使用**HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、PythonAI專案
- **教育內容**24 個結構化課程,組織成專案導向模組
- **作專案**Terrarium、打字遊戲、瀏覽器擴充功能、太空遊戲、銀行應用、程式碼編輯器和 AI 聊天助理
- **互動測驗**48 組測驗,每組包含 3 題(課前/課後評估
- **多語言支援**:透過 GitHub Actions 自動翻譯 50 多種語言
- **技術使用**HTML、CSS、JavaScript、Vue.js 3、Vite、Node.js、Express、Python用於 AI 專案)
### 架構
- 以課程為結構的教育資源庫
- 每堂課資料夾包含 README、範例程式與解答
- 單獨專案放在不同目錄quiz-app、各種課程專案
- 以課程為基礎的教育資源庫
- 每個課程資料夾包含 README、程式碼範例及解答
- 独立專案在不同目錄quiz-app、各種課程專案
- 使用 GitHub Actionsco-op-translator進行翻譯系統
- 使用 Docsify 提供文件,並有 PDF 版本
- 文件透過 Docsify 提供並可轉為 PDF
## 安裝指令
## 設定指令
本資源庫主要供教育內容使用。若要操作指定專案:
此資源庫主要用於教育內容的學習。若要操作特定專案:
### 主要資源庫安裝
### 主要資源庫設定
```bash
git clone https://github.com/microsoft/Web-Dev-For-Beginners.git
cd Web-Dev-For-Beginners
```
### 測驗應用程式安裝 (Vue 3 + Vite)
### 測驗應用程式設定 (Vue 3 + Vite)
```bash
cd quiz-app
npm install
npm run dev # 啟動開發伺服器
npm run build # 編譯為生產版本
npm run build # 建置生產環境
npm run lint # 執行 ESLint
```
@ -46,17 +46,17 @@ npm run lint # 執行 ESLint
```bash
cd 7-bank-project/api
npm install
npm start # 啟動 API 服器
npm start # 啟動 API 服
npm run lint # 執行 ESLint
npm run format # 使用 Prettier 格式化
```
### 瀏覽器擴充套件專案
### 瀏覽器擴充功能專案
```bash
cd 5-browser-extension/solution
npm install
# 遵循瀏覽器特定的擴充功能載入指示
# 遵循瀏覽器特定的擴充功能載入說明
```
### 太空遊戲專案
@ -64,7 +64,7 @@ npm install
```bash
cd 6-space-game/solution
npm install
# 在瀏覽器中打開 index.html 或使用 Live Server
# 在瀏覽器中打開 index.html 或使用即時伺服器
```
### 聊天專案 (Python 後端)
@ -80,38 +80,38 @@ python api.py
### 給內容貢獻者
1. **Fork 資源庫** 到你的 GitHub 帳號
2. **在本地端 clone 你的 fork**
3. **建立新的分支** 來做修改
4. 修改課程內容或者範例程式
5. 在相關專案目錄測試程式碼
6. 按照貢獻指南提交 Pull Requests
1. **Fork 資源庫** 到你的 GitHub 帳號
2. **Clone 你的 fork** 到本地端
3. **建立新分支** 進行修改
4. 對課程內容或程式碼範例做出修改
5. 在相關專案資料夾測試程式碼修改
6. 遵循貢獻指南提交 pull request
### 給學習者
1. Fork 或 clone 資源庫
2. 按課程順序瀏覽課程目錄
3. 閱讀每堂課的 README 檔
4. 在 https://ff-quizzes.netlify.app/web/ 完成課前測驗
5. 練習課程目錄中的範例程式
6. 完成作業和挑戰任務
7. 進行課後測驗
1. Fork 或 clone 資源庫
2. 序瀏覽課程目錄
3. 閱讀每個課程的 README 檔案
4. 完成 https://ff-quizzes.netlify.app/web/ 的課前測驗
5. 進行課程資料夾中的程式碼範例
6. 完成作業與挑戰
7. 參加課後測驗
### 即時開發
### 實時開發環境
- **文件**在根目錄執行 `docsify serve` 預設3000埠
- **測驗應用程式**:在 quiz-app 目錄執行 `npm run dev`
- **專案**:使用 VS Code 的 Live Server 延伸套件開啟 HTML 專案
- **API 專案**在對應 API 目錄執行 `npm start`
- **文件**於根目錄執行 `docsify serve` (port 3000)
- **測驗 App**:於 quiz-app 目錄執行 `npm run dev`
- **專案**:使用 VS Code Live Server 套件服務 HTML 專案
- **API 專案**於各 API 目錄執行 `npm start`
## 測試指引
## 測試說明
### 測驗應用程式測試
```bash
cd quiz-app
npm run lint # 檢查程式碼風格問題
npm run build # 驗證建置成功
npm run build # 確認建置成功
```
### 銀行 API 測試
@ -119,68 +119,68 @@ npm run build # 驗證建置成功
```bash
cd 7-bank-project/api
npm run lint # 檢查程式碼風格問題
node server.js # 驗證伺服器啟動是否無錯誤
node server.js # 驗證伺服器是否無錯誤啟動
```
### 一般測試方
### 一般測試方
- 本資源庫為教育用,無全面自動測試
- 人工測試重點:
- 範例程式碼無錯誤執行
- 文件中的連結可正常使用
- 專案正確建置成功
- 範例遵最佳實務
- 此為教育資源庫,無全面自動化測試
- 手動測試重點:
- 程式碼範例無錯誤執行
- 文件中連結正確
- 專案成功編譯
- 範例遵最佳實務
### 送出前檢查
### 提交前檢查
- 在有 package.json 的目錄執行 `npm run lint`
- 確認 markdown 連結有效
- 在瀏覽器或 Node.js 中測試範例程式
- 確保翻譯內容維持正確結構
- 於含 package.json 的目錄執行 `npm run lint`
- 驗證 markdown 連結有效
- 在瀏覽器或 Node.js 中測試程式碼範例
- 確認翻譯保持正確結構
## 程式碼風格指
## 程式碼風格指
### JavaScript
- 使用現代 ES6+ 語法
- 遵循專案所提供的 ESLint 標準設定
- 使用具意義的變數與函式名稱以利教學
- 添加說明概念的註解協助學習者
- 在配置 Prettier 的環境下格式化程式碼
- 遵循專案內 ESLint 既有設定
- 使用具有意義的變數與函式命名以便教學理解
- 補充註解說明概念給學習者
- 配合 Prettier 格式化(配置時)
### HTML/CSS
- 使用語意化 HTML5 元素
- 採用響應式設計原則
- 採用清晰的類別命名規則
- 加入說明 CSS 技術的註解幫助學習者理解
- 使用語意化 HTML5 元素
- 響應式設計原則
- 明確的類別命名慣例
- 補充 CSS 技巧註解給學習者
### Python
- 遵守 PEP 8 風格指
- 使用清晰且易於教學的程式碼範例
- 輔助教學處使用型別提示
- 遵守 PEP 8 風格指
- 清晰且具教學性的程式碼範例
- 依需求加入型別提示輔助學習
### Markdown 文件
- 清晰的標題層級結構
- 附帶語言標示的程式碼區塊
- 提供額外資源連結
- 在 `images/` 目錄含有截圖與圖片
- 圖片附加替代文字以利無障礙使用
- 清楚標題層級
- 指定語言的程式碼區塊
- 連結至附加資源
- 在 `images/` 目錄中放置截圖與圖片
- 為圖片標註替代文字以提升可及性
### 檔案組織
- 課程依序編號1-getting-started-lessons, 2-js-basics 等)
- 每個專案`solution/` 及常見的 `start/``your-work/` 目錄
- 圖片保存在特定課程的 `images/` 目錄
- 翻譯檔案置於 `translations/{language-code}/` 結構
- 課程依序編號1-getting-started-lessons2-js-basics 等)
- 每個專案包含 `solution/`,且常見 `start/``your-work/`
- 圖片儲存在各課程特定的 `images/` 資料夾
- 翻譯置於 `translations/{language-code}/` 結構
## 建置與部署
### 測驗應用程式部署 (Azure 靜態網站)
測驗應用程式已設定用於 Azure 靜態網站部署:
quiz-app 已設置為 Azure 靜態網頁應用部署:
```bash
cd quiz-app
@ -188,9 +188,9 @@ npm run build # 建立 dist/ 資料夾
# 在推送到 main 時透過 GitHub Actions 工作流程部署
```
Azure 靜態網站設定
Azure 靜態網站配置
- **應用程式位置**`/quiz-app`
- **輸出目錄**`dist`
- **輸出位置**`dist`
- **工作流程**`.github/workflows/azure-static-web-apps-ashy-river-0debb7803.yml`
### 文件 PDF 產生
@ -209,72 +209,72 @@ docsify serve # 在 localhost:3000 提供服務
### 專案特定建置
每個專案目錄可能有其建置流程:
- Vue 專案:`npm run build` 產生生產用套件
- 靜態專案:無需建置,直接提供檔案
各專案目錄可能有專屬建置流程:
- Vue 專案:`npm run build` 建立產線包
- 靜態專案:無建置步驟,直接服務檔案
## Pull Request 準則
## Pull Request 指南
### 標題格式
請用清楚描述更動範圍的標題:
使用清楚描述變更範圍的標題:
- `[Quiz-app] 新增第 X 課測驗`
- `[Lesson-3] 修正溫室專案錯字`
- `[Lesson-3] 修正 terrarium 專案錯字`
- `[Translation] 新增第 5 課西班牙語翻譯`
- `[Docs] 更新安裝說明`
- `[Docs] 更新設定指令`
### 必須檢查事項
### 必要檢查
PR 前:
PR 前:
1. **程式碼品質**
- 在影響專案目錄執行 `npm run lint`
- 修正所有錯誤及警告
- 在影響專案目錄執行 `npm run lint`
- 修正所有 lint 錯誤與警告
2. **建置驗證**
- 如適用,執行 `npm run build`
- 確保建置無錯誤
- 確認無建置失敗
3. **連結驗證**
- 測試所有 markdown 連結
- 確認圖片路徑有效
- 確認圖片參考正常
4. **內容審**
- 校對拼字文法
- 確認範例程式正確且具教學性
- 確保翻譯保持原意
4. **內容審**
- 校對拼字文法
- 確保程式碼範例正確且具教學意義
- 驗證翻譯保持原意
### 貢獻要求
- 同意微軟 CLA第一次 PR 會自動檢查)
- 遵守 [Microsoft 開源行為則](https://opensource.microsoft.com/codeofconduct/)
- 詳細指引請見 [CONTRIBUTING.md](./CONTRIBUTING.md)
- 如適用,於 PR 描述中提及議題編號
- 同意 Microsoft CLA次 PR 會自動檢查)
- 遵守 [Microsoft 開源行為則](https://opensource.microsoft.com/codeofconduct/)
- 詳細指見 [CONTRIBUTING.md](./CONTRIBUTING.md)
- 如有適用,在 PR 描述中引用議題號碼
### 審查流程
- PR 由維護者與社群審查
- 優先確保教育清晰度
- 範例程式需依當前最佳實務
- 翻譯審查重視準確與文化適當
- PR 經維護者及社群審核
- 優先確保教育清晰度
- 程式碼範例應遵循現行最佳實務
- 翻譯需審核精確與文化適切
## 翻譯系統
### 自動翻譯
- 使用 GitHub Actions 配合 co-op-translator
- 自動翻譯超過50種語言
- 原始檔位於主目錄
- 利用 GitHub Actions 搭配 co-op-translator 工作流程
- 自動翻譯超過 50 種語言
- 源檔置於主要目錄
- 翻譯檔置於 `translations/{language-code}/` 目錄
### 手動翻譯改進
1. 找`translations/{language-code}/`檔案
2. 在保留結構前提下進行改進
3. 確保範例程式仍可執
4. 測試地化測驗內容
1. 找`translations/{language-code}/` 下對應檔案
2. 保持結構下改進翻譯
3. 確保程式碼範例仍可正常運
4. 測試地化測驗內容
### 翻譯元資料
### 翻譯檔元數據
翻譯檔含元資料標頭:
```markdown
@ -289,120 +289,122 @@ CO_OP_TRANSLATOR_METADATA:
-->
```
## 除錯與問題排解
## 除錯與故障排除
### 常見問題
**測驗應用程式無法啟動**
**測驗應用無法啟動**
- 檢查 Node.js 版本(建議 v14 以上)
- 刪除 `node_modules``package-lock.json`重新執行 `npm install`
- 檢查埠號衝突Vite 預設使用 5173
- 刪除 `node_modules``package-lock.json`重新執行 `npm install`
- 檢查埠號衝突(預設:Vite 使用 port 5173
**API 伺服器無法啟動**
- 確認 Node.js 版本符合最低node >=10
- 檢查埠號是否被佔用
- 確保所有依賴已用 `npm install` 安裝
- 確認 Node.js 版本符合最低node >=10
- 確認埠號未被佔用
- 確保已執行 `npm install` 安裝依賴
**瀏覽器擴充無法載入**
**瀏覽器擴充功能無法載入**
- 確認 manifest.json 格式正確
- 查瀏覽器主控台錯誤訊息
- 遵循各瀏覽器擴充安裝指引
- 查瀏覽器主控台錯誤
- 遵照瀏覽器專屬的擴充功能安裝指引
**Python 聊天專案問題**
- 確認安裝 OpenAI 套件:`pip install openai`
- 確認 GITHUB_TOKEN 環境變數已設置
- 檢查 GitHub Models 存取權限
- 確認安裝 OpenAI 套件:`pip install openai`
- 檢查 GITHUB_TOKEN 環境變數是否設定
- 驗證 GitHub Models 存取權限
**Docsify 無法提供文件服務**
**Docsify 無法提供文件**
- 全域安裝 docsify-cli`npm install -g docsify-cli`
- 從資源庫根目錄啟動
- 從資源庫根目錄執行
- 確認 `docs/_sidebar.md` 存在
### 開發環境建議
### 開發環境提示
- 使用 VS Code 搭配 Live Server 擴充套件進行 HTML 開發
- 安裝 ESLint 和 Prettier 擴充維持一致格式
- 使用瀏覽器開發工具除錯 JavaScript
- Vue 專案安裝 Vue DevTools 瀏覽器擴充
- HTML 專案使用 VS Code Live Server 擴充
- 安裝 ESLint 和 Prettier 擴充以保格式一致
- 利用瀏覽器開發者工具除錯 JavaScript
- Vue 專案建議安裝 Vue DevTools 瀏覽器擴充
### 性能考量
- 超過50種語言翻譯檔案多完整克隆相當龐
- 若只工作於內容可用淺度克隆`git clone --depth 1`
- 編輯英文內容時可排除翻譯檔搜尋
- 初次執行建置流程可能較慢npm 安裝、Vite 建置
- 大量翻譯檔案50 多語言)使整體 clone 變
- 只作內容工作者可用淺層 clone`git clone --depth 1`
- 工作英語內容時可排除翻譯檔搜尋
- 初次運行建置流程速度可能較慢npm install、Vite build
## 安全考量
### 環境變數
- API 金鑰切勿提交至資源庫
- 使用 `.env` 檔案(已列入 `.gitignore`
- 必要環境變數於專案 README 文件中說明
- API 金鑰不得提交至資源庫
- 使用 `.env` 檔案(已 `.gitignore`
- 專案 README 中紀錄必要環境變數
### Python 專案
- 使用虛擬環境:`python -m venv venv`
- 定期更新相依套件
- GitHub token 使用最低權限原則
- 保持依賴最新版
- GitHub 令牌應授予最小必要權限
### GitHub Models 存取
- 需使用個人存取權杖 (PAT)
- 將 token 儲存在環境變數
- 切勿提交 token 或認證資訊
- 需個人存取令牌 (PAT) 以存取 GitHub Models
- 将令牌存為環境變數
- 禁止提交令牌或憑證
## 附
## 附加說明
### 目標對象
- 完全初學網頁開發者
- 完全初學網頁開發者
- 學生與自學者
- 教師用於課堂教學
- 內容設計兼顧可及性與循序漸進培養技能
- 內容設計以無障礙與循序漸進建構技能為主
### 教育哲學
### 教育理念
- 專案導向學習
- 頻繁的知識檢核(測驗)
- 實務程式練習
- 真實世界應用範例
- 先著重基礎,再談框架
- 專案導向學習方式
- 頻繁知識檢測(測驗)
- 動手程式練習
- 實境應用範例
- 強調基礎再介紹框架
### 資源庫維護
- 活躍的學習者與貢獻者社群
- 積極學習者與貢獻者社群
- 定期更新依賴與內容
- 維護者監控議題與討論
- 翻譯更新自動化透過 GitHub Actions
- 維護者監控議題與討論
- 翻譯由 GitHub Actions 自動更新
### 相關資源
- [Microsoft Learn 模組](https://docs.microsoft.com/learn/)
- [Student Hub 資源](https://docs.microsoft.com/learn/student-hub/)
- [學生中心資源](https://docs.microsoft.com/learn/student-hub/)
- 推薦學習者使用 [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
- 其他課程:生成式 AI、資料科學、機器學習、物聯網課程可參考
- 其他課程:生成式 AI、資料科學、機器學習、物聯網課程
### 操作特定專案說明
### 使用特定專案說明
個別專案詳細說明請參考以下 README
各專案詳細說明請參閱對應 README
- `quiz-app/README.md` - Vue 3 測驗應用程式
- `7-bank-project/README.md` - 含驗證的銀行應用程式
- `5-browser-extension/README.md` - 瀏覽器擴充套件開發
- `6-space-game/README.md` - 基於 canvas 的遊戲開發
- `7-bank-project/README.md` - 含身份驗證的銀行應用程式
- `5-browser-extension/README.md` - 瀏覽器擴充功能開發
- `6-space-game/README.md` - 以 Canvas 製作的遊戲
- `9-chat-project/README.md` - AI 聊天助理專案
### 多專案資源庫結構
### Monorepo 結構
雖非傳統 monorepo但本資源庫含多個獨立專案
雖非傳統 monorepo內含多個獨立專案
- 每堂課獨立完整
- 專案間無依賴共享
- 可獨立作業不影響其他專案
- 若需完整課程體驗可整個資源庫 clone
- 每堂課自成一體
- 專案間無共享依賴
- 可獨立開發專案,不影響其他專案
- 若需完整課程體驗,請克隆整個資源庫
---
<!-- CO-OP TRANSLATOR DISCLAIMER START -->
**免責聲明**
本文件係使用 AI 翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 進行翻譯。雖然我們力求準確,但請注意自動翻譯可能包含錯誤或不精確之處。原始文件之母語版本應視為權威來源。對於重要資訊,建議採用專業人工翻譯。我們不對因使用本翻譯而造成之任何誤解或誤譯負責。
**免責聲明**
本文件係使用 AI 翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 進行翻譯。雖然我們努力確保翻譯的準確性,但請注意自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應視為權威依據。對於重要資訊,建議尋求專業人工翻譯。我們不對因使用本翻譯而產生的任何誤解或誤譯負責。
<!-- CO-OP TRANSLATOR DISCLAIMER END -->
Loading…
Cancel
Save