feat: README修正

ecs/jskult-webapp/README.md

@@ -1,16 +1,21 @@
-# FastAPI 試作プロジェクト
+# 実消化&アルトマーク Webアプリケーション
 
 ## 概要
 
-PythonのWebフレームワーク「FastAPI」を利用して、MINE(旧称)のWebアプリケーションを開発してみるサンプルのリポジトリです。
+実消化&アルトマークのWebアプリケーション。
-新名称はMeDaCA(Merck Database for Commercial Application)を表示する。
+以下の機能を提供する
+
+- アルトマークデータ照会（施設・医師）
+- 生物由来データ照会
+- マスターメンテナンス
 
 ## 環境情報
 
 - Python 3.9
 - MySQL 8.x
+- FastAPI
+  - PythonのWebアプリケーションフレームワーク
 - VSCode
-- その他ライブラリ Pipfileを参照
 
 ## 環境構築
 
@@ -18,7 +23,7 @@ PythonのWebフレームワーク「FastAPI」を利用して、MINE(旧称)のW
   - Merck_NewDWH開発2021のWiki、[Python環境構築](https://nds-tyo.backlog.com/alias/wiki/1874930)を参照
     - 「Pipenvの導入」までを行っておくこと
   - 構築完了後、プロジェクト配下で以下のコマンドを実行し、Pythonの仮想環境を作成する
-    - `pipenv install`
+    - `pipenv install --python <pyenvでインストールしたpythonバージョン>`
     - この手順で出力される仮想環境のパスは、後述するVSCodeの設定手順で使用するため、控えておく
 
 - MySQLの環境構築
@@ -51,7 +56,6 @@ PythonのWebフレームワーク「FastAPI」を利用して、MINE(旧称)のW
 ├── Pipfile                             -- Pythonモジュールの依存関係を管理するファイル
 ├── Pipfile.lock                        -- Pythonモジュールの依存関係バージョン固定用ファイル
 ├── README.md
-├── auth_flow.drawio                    -- 認証フローの説明図 
 └── src                                 -- ソースコードの保管場所
     ├── aws                             -- AWSリソース操作用のコード
     │   ├── aws_api_client.py
@@ -65,7 +69,7 @@ PythonのWebフレームワーク「FastAPI」を利用して、MINE(旧称)のW
     │   └── menu.py
     ├── core                            -- APサーバーのコア設定。
     │   └── tasks.py                    -- 起動・終了時に実行するタスクを設定。
-    ├── data                            -- 生物由来照会のエクセルファイルテンプレート。これはS3に持っていくかも。
+    ├── data                            -- 生物由来照会のエクセルファイルテンプレート。
     │   └── BioData_template.xlsx
     ├── db                              -- データベース関連処理。
     │   ├── database.py                 -- データベース接続、クエリ発行の共通モジュール。
@@ -163,7 +167,7 @@ PythonのWebフレームワーク「FastAPI」を利用して、MINE(旧称)のW
   - REPOSITORIES定数に、依存するリポジトリクラスを辞書形式で指定する
   - CLIENTS定数に、依存するAWS APIクライアントクラスを辞書形式で指定する
   - `__init__`コンストラクタ内で、2つの定数に指定したキーに紐付いたインスタンスが渡ってくるため、インスタンス変数として登録する
-  - あとは、ビジネスロジックにあたる関数を生やしていくだけ
+  - あとは、ビジネスロジックにあたる関数を生やしていく
 - DBへのアクセスを行うリポジトリクラスは「repositories」フォルダに格納する。
   - SQL文を用意し、`_db`インスタンス変数のメソッドを利用してクエリを実行する。
   - 必要に応じて条件設定をする。条件設定には`SQLCondition`クラスを使用する。