Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
既存ユーザーへの影響がある場合 (互換性・デグレ・破壊的変更など) は必ず説明に含めてください。

## チェック項目
- [ ] npm run lint を実行した
- [ ] `npm run lint` を実行した
- [ ] 関連するドキュメントを修正した
- [ ] 手元の環境で動作確認済み
- [ ] `npm run cdk:test` を実行しスナップショット差分がある場合は `npm run cdk:test:update-snapshot` を実行してスナップショットを更新した

## 関連する Issue
関連する Issue を可能な限り挙げてください。
1 change: 1 addition & 0 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ jobs:
- run: npm run web:lint
- run: npm run cdk:lint
- run: npm run web:build
- run: npm run cdk:test
- run: npm -w packages/cdk run cdk synth
873 changes: 690 additions & 183 deletions docs/DEPLOY_OPTION.md

Large diffs are not rendered by default.

15 changes: 14 additions & 1 deletion docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

開発者用にローカル環境を構築する手順を説明します。なお、ローカル環境を構築する場合も、[AWS へのデプロイ](/README.md#デプロイ)は完了している必要があります。

### Unix 系コマンドが使えるユーザー (Cloud9, Linux, MacOS 等)
### (推奨) Unix 系コマンドが使えるユーザー (Cloud9, Linux, MacOS, Windows WSL/Bash/Git Bash 等)

以下のコマンドを実行することで、必要な環境変数を CloudFormation の Output から動的に取得し、サーバーを起動します。
なお、内部で `aws` コマンドと `jq` コマンドを利用しているので、未インストールの場合はインストールしてから実行してください。
Expand All @@ -19,6 +19,9 @@ npm run web:devw
> export AWS_DEFAULT_REGION=''
> ```

> [!TIP]
> バックエンドの環境を切り替えて利用したい際は、cdk.json の context.env を変更するか、`npm run web:devw --env=dev2` のようにコマンドライン引数で指定してください。

### その他のユーザー (Windows 等)

デプロイ完了時に表示される Outputs から API の Endpoint (Output key = APIApiEndpoint...)、Cognito User Pool ID (Output key = AuthUserPoolId...)、Cognito User Pool Client ID (Output Key = AuthUserPoolClientId...) 、Cognito Identity Pool ID (Output Key = AuthIdPoolId...)、レスポンスストリーミングの Lambda 関数の ARN (Output Key = APIPredictStreamFunctionArn...) を取得します。
Expand Down Expand Up @@ -103,3 +106,13 @@ npm run web:dev
```bash
npm run lint
```

また、CDK に変更があれば以下のコマンドでスナップショットの確認を行いスナップショットを更新してください。

```bash
# 差分を確認
npm run cdk:test

# テストを更新
npm run cdk:test:update-snapshot
```
Loading