README.md

OISM -- PH 店舗管理システム Backend

プレビュー

システム概要

OSIM は EC ショップのバックオフィスに必要な機能をまとめて提供するサービスです。

主な機能

以下機能が含まれています

注文管理

• 注文の受付
• 注文の状態管理

在庫管理

• 入庫・出庫
• 履歴管理
• 倉庫間移動

出荷管理

• 出荷の作成生
• 輸送ベンダー管理
• 輸送帳票生成

コラボレーション

• 複数ユーザ
• ユーザー間のリアルタイム情報更新

外部連携

• Google Workspace への通知
• Google Workspace へのタスク割り当て

システム構成

** 図 Backend:MainService 部分が本プロジェクト

Development

Requirement

• メインデータベースの起動が必要。

• justのインストールが必要

Dev サーバー起動

just dev

Test

just test-all

構造図生成

just generate-structure

プロジェクトのコンフィグレーション

ローカル環境と本番環境の切り替えはAPP_ENVIRONMENT環境変数で行う。

configを利用しており、利用法はdoc参照 本プロジェクトのコンフィグレーションは階層構造を採用しており、 最優先：コンフィグレーション用環境変数 次優先：configurationsフォルダー内のtomlファイル

具体的な設定内容はソースファイルを参照してください

コンフィグレーション用環境変数

環境変数にプレフィックスOISMをつけることで、コンフィグレーション用環境変数として読み込みできる。

configurationsフォルダー内のtomlファイル

base.tomlが基本設定ファイルで、かならず読み込まれる。 local.tomlはローカル環境用設定ファイルで、base.tomlを上書きする。 production.tomlは本番環境用設定ファイルで、base.tomlを上書きする。