Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrandaws committed Apr 11, 2024
1 parent 98b9ccd commit 4565319
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ npm run cdk:deploy
- [アップデート方法](/docs/UPDATE.md)
- [ローカル開発環境構築手順](/docs/DEVELOPMENT.md)
- [リソースの削除方法](/docs/DESTROY.md)
- [AWS 上で完結するデプロイ方法 (手元に環境を用意することが難しい場合)](/docs/DEPLOY_ON_AWS.md)

## 参照
- [ブログ: Generative AI Use Cases JP をカスタマイズする方法](https://aws.amazon.com/jp/blogs/news/how-to-generative-ai-use-cases-jp/)
Expand Down
63 changes: 63 additions & 0 deletions docs/DEPLOY_ON_AWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# AWS 上で完結するデプロイ方法 (手元に環境を用意することが難しい場合)

AWS CloudShell と AWS Cloud9 を利用することで、手元の環境に依存しないデプロイが可能です。(デプロイが AWS 上で完結します。)

## Cloud9 環境の作成

[cloud9-setup-for-prototyping](https://github.com/aws-samples/cloud9-setup-for-prototyping) を利用します。cloud9-setup-for-prototyping で作成した環境は、デフォルトで作成される Cloud9 環境とは違い、メモリやストレージ不足、権限不足などのハマりどころに対処しています。[AWS CloudShell](https://console.aws.amazon.com/cloudshell/home) を開き、[cloud9-setup-for-prototyping の README.md](https://github.com/aws-samples/cloud9-setup-for-prototyping) の手順に従って Cloud9 環境を作成します。以下に、実行コマンドだけを端的に示します。詳細は README.md でご確認ください。

```bash
git clone https://github.com/aws-samples/cloud9-setup-for-prototyping
cd cloud9-setup-for-prototyping
./bin/bootstrap
```

作成が完了すると、[AWS Cloud9](https://console.aws.amazon.com/cloud9control/home) に cloud9-for-prototyping という環境が作成されているので、Open をクリックし IDE を開きます。
以下の全ての手順は、作成した IDE で行います。

## generative-ai-use-cases-jp のデプロイ

IDE 下部の Terminal で以下のコマンドを実行します。generative-ai-use-cases-jp を git clone し、作業ディレクトリに移動しています。

```bash
git clone https://github.com/aws-samples/generative-ai-use-cases-jp
cd generative-ai-use-cases-jp/
```

その後の手順は [generative-ai-use-cases-jp の README.md](/README.md#デプロイ) の手順に従ってください。以下に、実行コマンドだけを端的に示します。

```bash
npm ci
npx -w packages/cdk cdk bootstrap # 必要な場合のみ CDK Bootstrap (重複して実行されても問題はない)
npm run cdk:deploy
```

## デプロイオプションの設定変更

`cloud9-for-prototyping/generative-ai-use-cases-jp/packages/cdk/cdk.json` を開き、context 内の項目を変更します。設定可能な内容については[こちら](/docs/DEPLOY_OPTION.md)をご参照ください。

cdk.json の内容を変更したら、ファイルを保存して、`npm run cdk:deploy` を実行します。デプロイすることで設定変更が反映されます。

## フロントエンドの開発

Cloud9 の Preview 機能を使うためには、localhost の 8080 ~ 8082 ポートで Listen する必要があります。([参考](https://docs.aws.amazon.com/ja_jp/cloud9/latest/user-guide/app-preview.html)) generative-ai-use-cases-jp のフロントエンド開発で利用している [Vite](https://ja.vitejs.dev/) はデフォルトで 5173 ポートを使うため、これを変更します。

`cloud9-for-prototyping/generative-ai-use-cases-jp/packages/web/package.json` を開き、scripts の中の dev コマンドを `vite` から `vite --port 8080` に変更します。変更後の package.json の一部は以下のようになります。(なお、vite.config.ts でポートを設定することも可能ですが、ここでは案内しません。)

```json
{
"name": "web",
"private": true,
"type": "module",
"scripts": {
"dev": "vite --port 8080",
... 省略
```

変更後にファイルを保存してください。その後は[こちら](/docs/DEVELOPMENT.md) の手順に従います。以下のコマンドを実行してください。

```bash
npm run web:devw
```

実行後、IDE 上部の Preview をクリックし Preview Running Application をクリックします。これで IDE 内にブラウザが表示されます。フロントエンドのコードを変更すると、リアルタイムで画面に変更が適用されます。IDE 内のブラウザの右上に「別画面で開く」アイコンのボタンがあります。そちらをクリックすることで、ブラウザの別タブで Preview を開くことができます。別タブで開いたあとは、IDE 内のブラウザは閉じてしまって構いません。

0 comments on commit 4565319

Please sign in to comment.