11# 開発者向け情報
22
3- Nuxt.jsに関する内容、Firebaseに関する内容は各ドキュメントを参照してください 。
4- 詳しい内容は下記のURLを参照ください
3+ Nuxt.js に関する内容、Firebase に関する内容は各ドキュメントを参照してください 。
4+ 詳しい内容は下記の URL を参照ください
55
6- [ おうちで時間割 Nuxt版 仕様書 \- HackMD] ( https://hackmd.io/hltUcnt2S0eQEv1Heif7zw?both )
6+ [ おうちで時間割 Nuxt 版 仕様書 \- HackMD] ( https://hackmd.io/hltUcnt2S0eQEv1Heif7zw?both )
77
88## 1. 環境構築
99
1010以下のアプリケーションを開発をおこなう環境へインストールします。
1111
12- | アプリケーション名 | バージョン<br >(指定がある場合のみ記載) | インストール条件 |
13- | ------- | ------- | ------- |
14- | [ Node.js] ( https://nodejs.org/ja/ ) | 10.19.0以上 | 必須 |
15- | [ Visual Studio Code] ( https://code.visualstudio.com/ ) | | Visual Studio Codeを利用する場合 |
16- | [ Yarn] ( https://classic.yarnpkg.com/ja/ ) | | 本プログラムをyarnで実行する場合 |
17- | [ Docker Engine] ( https://docs.docker.com/engine/install/ ) ,[ Docker Compose] ( https://docs.docker.com/compose/install/ ) | | 本プログラムをdocker composeで実行する場合 |
12+ | アプリケーション名 | バージョン<br >(指定がある場合のみ記載) | インストール条件 |
13+ | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------- ------- |
14+ | [ Node.js] ( https://nodejs.org/ja/ ) | 10.19.0 以上 | 必須 |
15+ | [ Visual Studio Code] ( https://code.visualstudio.com/ ) | | Visual Studio Code を利用する場合 |
16+ | [ Yarn] ( https://classic.yarnpkg.com/ja/ ) | | 本プログラムを yarn で実行する場合 |
17+ | [ Docker Engine] ( https://docs.docker.com/engine/install/ ) ,[ Docker Compose] ( https://docs.docker.com/compose/install/ ) | | 本プログラムを docker compose で実行する場合 |
1818
19- ### 1-1. Visual Studio Codeの拡張機能
19+ ### 1-1. Visual Studio Code の拡張機能
2020
21- Visual Studio Codeを利用する場合は 、以下の拡張機能をインストールします。
21+ Visual Studio Code を利用する場合は 、以下の拡張機能をインストールします。
2222
23- | 拡張機能 | インストール条件 |
24- | ------- | ------- |
25- | [ ESLint] ( https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint ) | 任意 |
26- | [ Vetur] ( https://marketplace.visualstudio.com/items?itemName=octref.vetur ) | 任意 |
27- | [ TSLint] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin ) | 任意 |
28- | [ Debugger for Chrome] ( https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome ) | 任意 |
29- | [ Remote Development] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack ) | Visual Studio CodeでRemote Developmentを利用する場合 |
23+ | 拡張機能 | インストール条件 |
24+ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ ------- |
25+ | [ ESLint] ( https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint ) | 任意 |
26+ | [ Vetur] ( https://marketplace.visualstudio.com/items?itemName=octref.vetur ) | 任意 |
27+ | [ TSLint] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin ) | 任意 |
28+ | [ Debugger for Chrome] ( https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome ) | 任意 |
29+ | [ Remote Development] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack ) | Visual Studio Code で Remote Development を利用する場合 |
3030
3131---
3232
3333## 2. 実行
3434
35- コマンドの実行は、WorkingCopyのルートディレクトリでおこないます 。
35+ コマンドの実行は、WorkingCopy のルートディレクトリでおこないます 。
3636
3737### 2-1. ` yarn ` を使う場合
3838
@@ -89,12 +89,12 @@ $ docker-compose run --rm app yarn install
8989
9090## 4. ステージング・本番環境への反映
9191
92- 下表の左列に記載されたブランチが更新されると、ブランチとWebサイトの更新が自動的におこなわれます 。
92+ 下表の左列に記載されたブランチが更新されると、ブランチと Web サイトの更新が自動的におこなわれます 。
9393
94- | 更新対象 | 自動的に更新されるブランチ | 更新されるWebサイト |
95- | ---- | ---- | ---- |
96- | ` master ` | 無し | 本番サイト https://studyathome.web.app/ |
97- | ` development ` | 無し | 開発用サイト https://studyathome-dev.web.app/ |
94+ | 更新対象 | 自動的に更新されるブランチ | 更新される Web サイト |
95+ | ------------- | -------------------------- | ----------------------------------------- ---- |
96+ | ` master ` | 無し | 本番サイト https://studyathome.web.app/ |
97+ | ` development ` | 無し | 開発用サイト https://studyathome-dev.web.app/ |
9898
9999---
100100
@@ -103,15 +103,15 @@ $ docker-compose run --rm app yarn install
103103development 以外は、Pull Request は禁止です。
104104Pull Request を送る際のブランチは、以下のネーミングルールに従ったブランチにしてください。
105105
106- | 種類 | ブランチのネーミングルール |
107- | ---- | ---- |
108- | 機能追加系| ` feature/#{ISSUE_ID}-#{branch_title_name} ` |
109- | フィックス系| ` fix/#{ISSUE_ID}-#{branch_title_name} ` |
110- | ホットフィックス系| ` hotfix/#{ISSUE_ID}-#{branch_title_name} ` |
106+ | 種類 | ブランチのネーミングルール |
107+ | ------------------ | -------------------------------------- ---- |
108+ | 機能追加系 | ` feature/#{ISSUE_ID}-#{branch_title_name} ` |
109+ | フィックス系 | ` fix/#{ISSUE_ID}-#{branch_title_name} ` |
110+ | ホットフィックス系 | ` hotfix/#{ISSUE_ID}-#{branch_title_name} ` |
111111
112112### 5-1. 基本的なブランチ
113113
114- | 目的 | ブランチ | 確認URL | Pull requestsを出せる人 | 備考 |
115- | ---- | ---- | ---- | ---- | ---- |
116- | 開発 | development | https://studyathome-dev.web.app/ | 全開発者 | base branch。基本は、この` development ` ブランチに Pull Requestを送ってください 。 |
117- | 本番 | master | https://studyathome.web.app/ | 管理者のみ | 管理者以外の Pull Request は禁止です。 |
114+ | 目的 | ブランチ | 確認 URL | Pull requests を出せる人 | 備考 |
115+ | ---- | ----------- | -------------------------------- | ------------------------ | ---------------------------------------------------------------------------- ---- |
116+ | 開発 | development | https://studyathome-dev.web.app/ | 全開発者 | base branch。基本は、この` development ` ブランチに Pull Request を送ってください 。 |
117+ | 本番 | master | https://studyathome.web.app/ | 管理者のみ | 管理者以外の Pull Request は禁止です。 |
0 commit comments