OMDSCloud/environment_building_tools/README.md

開発環境構築ツール

このディレクトリには、ローカル開発環境を構築するためのスクリプト、クライアントのビルドスクリプト、サーバー起動スクリプトが含まれています。

前提

1. dictation_client と dictation_server のローカル環境ファイル .env.local 設定されたこと

2. Docker インストール済み

   Docker

3. DevContainer CLI インストール済み

   npm install -g @devcontainers/cli
   

ファイル一覧

• environment-build-local.sh
  初期ローカル開発環境をセットアップするためのスクリプトです。依存関係のチェック、MySQL データベースの設定、Dev Container のインストールを確認し、ローカル構築をします。

• buildclient.sh
  dictation_client コンテナの起動、クライアントサイドの依存関係をインストールし、サーバー環境のファイルをビルドします。

• runserver.sh
  dictation_server コンテナの起動、依存関係のインストールし、サーバーの起動を行います。

• killserver.sh
  現在稼働しているコンテナプロセスを停止するためのスクリプトです。

• logfile.log
  各スクリプトの実行中に発生するログを記録するファイルです。

使用方法

1. 依存関係の確認
   environment-build-local.sh を実行すると、Docker、Dev Container CLI の依存関係を確認、.env.localファイル確認し、環境構築します。

   sh environment-build-local.sh
   

2. クライアントのセットアップ buildclient.sh を使用して dictation_client をセットアップします。

   sh buildclient.sh
   

3. サーバーの起動 runserver.sh を実行して dictation_server を起動します。

   sh runserver.sh
   

4. サーバーの停止 サーバーを停止したい場合は killserver.sh を実行します。

   sh killserver.sh
   

ログ

各スクリプトの実行中のメッセージは logfile.log に記録されます。エラーメッセージとステータスを確認したい場合は、このファイルを参照してください。

手動でのクライアントビルド手順

1. dictation_client フォルダを VSCode で開く。

2. DevContainer で開くか確認するダイアログが表示されたら、「DevContainer で開く」を選択。

3. ターミナルで以下のコマンドを実行：

   npm install
   npm run build:local
   

手動でのサーバー起動手順

1. dictation_server フォルダを VSCode で開く。

2. DevContainer で開くか確認するダイアログが表示されたら、「DevContainer で開く」を選択。

3. ターミナルで以下のコマンドを実行：

   npm install
   npm run start