QuestionGPTPortal

概要

QuestionGPTTranslatorを API サーバーとする Web アプリケーションを構成する。

使用する主要なパッケージのバージョン

名称	バージョン
Node.js	20.10.0
React	18.3.1
Typescript	5.5.3

上記以外のパッケージは、dependabot によってバージョン管理している。

初期構築

Web アプリケーションをデプロイした GitHub Pages を構築する事前準備として、以下の順で初期構築を必ずすべて行う必要がある。

1. API サーバーの Azure リソース構築
2. リポジトリの変数設定

1. API サーバーの Azure リソース構築

QuestionGPTTranslator の Azure リソース環境構築の構築手順に従って、API サーバーの Azure リソースを構築する。

2. リポジトリの変数設定

QuestionGPTPortal リポジトリの Setting > Secrets And variables > Actions の Variables タブから「New repository variable」ボタンを押下して、下記の通り変数をすべて設定する。

変数名	変数値
API_URI	QuestionGPTTranslator の API Managementqgtranslator-je-apim の Gateway URL
AZURE_AD_SP_MSAL_CLIENT_ID	QuestionGPTTranslator で発行した QGTranslator_MSAL のクライアント ID
AZURE_TENANT_ID	Azure ディレクトリ ID

localhost 環境構築

GitHub Pages を構築せず、localhost の 5173 番のポート上で Web サーバーを起動することもできる。 以下では、QuestionGPTTranslator の localhost 環境構築の構築手順に従って、localhost の 9229 番のポート上で API サーバーを起動したもとで、localhost に Web サーバーを構築・削除する手順を示す。

構築手順

1. 環境変数VITE_API_URIに API サーバーのオリジンを記載したファイル.envを、QuestionGPTPortal リポジトリ直下に保存する。 例えば、API サーバーを localhost の 9229 番のポート上で起動し、http://localhost:9229/apiをエンドポイントに持つ場合、以下の通りに指定する。

   VITE_API_URI="http://localhost:9229"
   

2. ターミナルを起動して以下のコマンドを実行し、npm パッケージをインストールする。

   npm i

3. 2 のターミナルで以下のコマンドを実行し、localhost に Web サーバーを起動する。実行したターミナルはそのまま放置する。

   npm run dev

削除手順

構築手順の 3 で実行したターミナルに対して Ctrl+C キーを入力すると、localhost に起動した Web サーバーを停止・削除できる。

API サーバーの API リファレンス

Swagger UI参照。

完全初期化

初期構築以前の完全なクリーンな状態に戻すためには、初期構築で行ったサービスプリンシパル・変数それぞれを以下の順で削除すれば良い。

1. リポジトリの各シークレット・変数の削除
2. API サーバーの Azure リソース削除

1. リポジトリの変数の削除

QuestionGPTPortal リポジトリの Setting > Secrets And variables > Actions より、Variables タブから初期構築時に設定した各変数に対し、ゴミ箱のボタンを押下する。

2. API サーバーの Azure リソース削除

QuestionGPTTranslator の Azure リソース環境構築の削除手順に従って、API サーバーの Azure リソースを削除する。