Repository

リポジトリ主要ディレクトリ・ファイル概要

+---database/         ━ ● DB定義用DDLファイル格納ディレクトリ
|
+---docs/             ━ ●ドキュメント（mkdocs)ファイル格納ディレクトリ
|
+---firebase/         ━ ● Firebase Functions, Hosting関連ディレクトリ（Nodejs）
|   |   deploy_cht-farmnote-gene-dev.bat   ┓
|   |   deploy_farmnote-gene-dev.bat       ┃ Functions, Hosting デプロイ用バッチ（Firebase Projectごと）
|   |   deploy_farmnote-gene-prod.bat      ┛
|   |   firebase.json                      ━ Firebase設定（※1）
|   |   package-lock.json                  ┓ Nodeパッケージ管理設定ファイル
|   |   package.json                       ┛
|   |   run_cloudsql_proxy_cht-farmnote-gene-dev.bat   ┓ ローカルpsqlコマンド
|   |   run_cloudsql_proxy_farmnote-gene-dev.bat       ┃   CloudSQL接続用プロキシ起動スクリプト 
|   |   run_cloudsql_proxy_farmnote-gene-prod.bat      ┛  （ローカル開発用）
|   |   run_firebase_emulator.bat                      Firebaseエミュレータ起動スクリプト（ローカル開発用）
|   |   storage.rules                  ━ Firebase Storageアクセス許可ルール（デプロイ時に反映）
|   |
|   +---cloud_sql_proxy/       
|   |       cloud_sql_proxy_x64.exe    ━ CloudSQLプロキシ本体
|   |
|   +---functions/           ━ functions関連格納ディレクトリ
|   |   |   index.js             ━ functions機能エンドポイント記述ファイル
|   |   |   package-lock.json    ┓ nodejsパッケージ管理ファイル
|   |   |   package.json         ┛
|   |   |
|   |   +---config/          ━ farmnote-gene functions機能設定ファイル格納ディレクトリ
|   |   |
|   |   \---module/          ━ APIプログラムモジュール格納ディレクトリ
|   |       |
|   |       \---common/      ━ プログラム共通モジュール格納ディレクトリ
|   |
|   \---public/            ━  Firebase Hosting対象ファイル格納ディレクトリ(※2)
|
+---fngene/             ━ ● エンジン関連ディレクトリ（Python）
|   |   requirements.txt  ━ Python必要モジュールリスト（Freeze出力）
|   |
|   \---batch/            ━ バッチ関連格納ディレクトリ
|       |   make_job.py           ━ ジョブ作成プログラム（定時実行）
|       |   process_manager.py    ━ エンジンプロセスマネージャー
|       |   worker.py             ━ エンジンワーカー
|       |
|       +---common/               ━ プロセスマネージャー、ワーカー共通モジュール
|       |
|       +---config/               ━ プロセスマネージャー、ワーカー設定ファイル
|       |
|       \---engine/               ━ エンジン関連ディレクトリ
|           |   engine_base.py      ━ エンジン基底クラス
|           |
|           \---v002/               ━ エンジンバージョンディレクトリ
|               \---data_process      ━ エンジンdata_processディレクトリ
|                   \----engine.py       ━ エンジン本体（cli.pyを調整したプログラム）
\---gcp/                 ━ GCP作業用ファイル格納ディレクトリ
    \---gce/               ━ GCE用ファイル格納ディレクトリ 
        |   readme.txt       ━ GCE環境説明
        |
        \---ssh-key/         ━ SSHアクセス用秘密鍵格納ディレクトリ

※1 Hostingのヘッダー設定（CROS対応、Access-Control-Allow-Origin）あり
※2 CHT側では、サーバAPIのテスト用HTMLのみ、本番では不要

● はトップディレクトリ
プログラム本体はfirebase以下、fngene以下の２種類
firebase ディレクトリ以下はFirebase環境にデプロイする
fngene ディレクトリはGCEインスタンス内に配置する