Skip to content

Commit

Permalink
プレイグラウンドの使い方、アカウントの追加方法をドキュメントに記載 (#37)
Browse files Browse the repository at this point in the history
* Add how to add user
* Add how to use

---------

Co-authored-by: Takahiro Kubo <[email protected]>
  • Loading branch information
icoxfog417 and Takahiro Kubo authored Nov 28, 2023
1 parent f86e48a commit 9cc2ab7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,31 @@ npx -w packages/cdk cdk bootstrap
npm run cdk:deploy
```

アプリケーションのデプロイが完了したら、コンソールに出力される `WebUrl` の URL からアクセスしてください。コンソールの出力をとり漏らした場合は、 AWS Console にログインし次の手順で確認してください。

1. 画面上部の検索バーで "CloudFormation" を検索し、 CloudFormation の管理画面に遷移。
* この時、 AWS のリージョンが CDK deploy したリージョンで同じであることを確認してください。
2. 左側のメニューから「スタック」を選択。メインパネルに表示されたスタックの一覧から "GenerativeAiUseCasesStack" を選択。
3. 画面右にスタックの情報が出力される。「出力」のタブからキーが "WebUrl" になっているものを探すと、値の箇所に URL が記載されている。

URL にアクセスするとログイン画面に遷移します。アカウントを作成する際は、 AWS Console にアクセスし次の手順で作成してください。

### アカウント作成手順

1. 画面上部の検索バーで "Cognito" を検索し、 Amazon Cognito の管理画面に遷移。
* この時、 AWS のリージョンが CDK deploy したリージョンで同じであることを確認してください。
2. ユーザープールを選択
* ユーザープールが複数ある場合は、上述の `WebUrl` の特定方法をなぞりキーが `UserPoolId` の値を確認し、ユーザープール ID が確認した値と一致するものを選択してください。
3. 「ユーザー」のタブから「ユーザーを作成」を押す。
4. E メールアドレス、パスワードを入力し「ユーザーを作成」を押す。
* パスワードを E メールで連絡したい場合は、「 E メールで招待を送信」を選択してください。それ以外の場合、 Slack の DM など個別の方法で送ってください。

### プレイグラウンドの利用方法

下記動画を参考にしてください。エンドポイントが起動していない場合は差最初に起動する必要があります。起動したエンドポイントは、リクエストがない場合自動的に停止します。

![playground.gif](./imgs/playground.gif)

## 開発

本アプリケーションを修正する場合、 [DEVELOPMENT.md](docs/DEVELOPMENT.md) を参照し開発環境を構築してください。修正内容を本リポジトリに送っていただける場合は、 [CONTRIBUTING](CONTRIBUTING.md) を参照ください。
Expand Down
Binary file added imgs/playground.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9cc2ab7

Please sign in to comment.