サンプルアプリケーション概要
SaaSus Platformを使った実際のSaaSアプリケーションの実装例です。 認証、テナント管理、課金機能など、SaaSに必要な機能を動かしながら学習できます。
主な特徴
- 実践的: 実際のSaaSで使われる機能を網羅
- React + TypeScript: フロントエンドにReactを使用
- 多言語対応: Go、Python、Java、C#の実装例
実装方式について
このサンプルアプリケーションは、APIサーバ版として実装されています。
APIサーバ版の特徴
バックエンドをAPIサーバで構成する実装方式で、以下のような特徴があります：
- SaaSus Platformの認証情報となるトークン（JWT）を、ブラウザのローカルストレージに保管
- SaaS Platform利用者はJWTを使って本人確認を行う
- フロントエンドはReactで実装
- バックエンドのAPIサーバはGo / Python / Java / C#で実装例を提供
処理フロー（ログイン〜ユーザ一覧表示）
実装されている画面・機能一覧
認証関連画面
Callback.tsx - 認証後遷移先画面
- SaaSus Platformからの認証情報を受け取り
- JWTトークンをローカルストレージに保存
- ユーザーのロールに応じて適切な画面に自動遷移
- ※リダイレクト処理のため、ユーザーには表示されません
SelfSignUp.tsx - セルフサインアップ画面
- 新規ユーザーが自分でテナント作成
- テナント名の入力
- ユーザー属性・テナント属性の設定
- 属性タイプ別の入力フィールド（文字列、数値、真偽値、日付）
ユーザー・テナント管理画面
TenantList.tsx - テナント一覧画面
- 複数テナントに所属するユーザー向け
- テナント属性の表示（設定済み/未設定の表示）
- 各テナントのユーザー一覧画面への遷移
UserPage.tsx - ユーザー一覧画面（メイン画面）
- ログインユーザー情報表示: テナント名、名前、メールアドレス、ロール、料金プラン
- ユーザー一覧テーブル: テナント内の全ユーザー表示
- ユーザー属性表示: カスタム属性の動的表示
- 管理者機能リンク: 管理者のみ表示される機能へのリンク
- ユーザー削除機能: 管理者権限でのユーザー削除
ユーザー管理機能
UserRegister.tsx - ユーザー新規登録画面
- メールアドレス・パスワード入力
- ユーザー属性の設定
- 属性タイプ別の入力フィールド対応
UserInvitation.tsx - ユーザー招待画面
- メールアドレスでの招待送信
- 招待一覧の表示（メール、招待リンク、役割、ステータス、有効期限）
- 招待ステータスの管理
DeleteUserLog.tsx - ユーザー削除ログ画面
- 削除されたユーザーの履歴表示
- テナントID、ユーザーID、メールアドレス、削除日時
課金・メータリング機能
PlanSettings.tsx - プラン設定画面
- 現在のプラン表示: プラン名、税率、変更予約情報
- プラン変更機能: 新しいプラン選択、税率設定
- 反映日設定: 即時反映（5分後）または日時指定
- プラン解除機能: 現在のプランの解除
- 予約管理: プラン変更予約の取り消し
- 編集制限: 変更予定が近い場合の編集ロック
BillingDashboard.tsx - 課金情報ダッシュボード
- 課金サマリー: 通貨別合計金額、計測単位数
- 料金プラン情報: プラン詳細、税率情報
- 期間選択: 月次/年次の請求期間選択
- 計測単位別課金情報: 使用量と課金額の詳細表示
- リアルタイムメータ更新: インライン編集（+/-ボタン）
- メータ更新モーダル: 任意の値での増減、履歴補正
セキュリティ機能
UserMfaSettingDialog.tsx - 多要素認証設定ダイアログ
- 認証方式選択: 認証アプリ（TOTP）とメール認証から選択
- MFA状態確認: 有効/無効と現在の認証方式の確認
- 認証アプリ設定: QRコード表示と6桁コードの検証
- メール認証設定: ワンクリックでメール認証を有効化
- 方式切り替え: 設定済みの認証方式から別の方式へ変更
- MFA無効化: 多要素認証の解除
実装されている機能
カスタム属性機能
- ユーザー・テナント属性の柔軟な設定と表示
- 文字列、数値、真偽値、日付など様々な属性タイプに対応
- 属性値の自動バリデーション
メータリング
- 使用量のリアルタイム更新
- インライン編集による簡単な増減操作
- 過去の使用量データの修正機能
権限制御
- ロール別の機能制限と表示制御
- 管理者のみアクセス可能な機能の実装
- ユーザーの権限に応じた画面表示の切り替え
行動履歴ログ
X-SaaSus-Refererヘッダーによる詳細な行動追跡- ページ表示とアクション実行の区別
セットアップ手順
前提条件
- Node.js: 16以上
- 開発環境: 各言語の開発環境（Go, Python, Java, C#）
- SaaSus Platform: アカウントとプロジェクト設定
セットアップ手順
1. SaaSus Platformの設定
- SaaS 開発コンソールで認証後遷移先URLを設定（
http://localhost:3000/callback） - 必要な設定値を取得：
- ログイン画面のURL
- APIキー等の認証情報
2. フロントエンドのセットアップ
# リポジトリのクローン
git clone https://github.com/saasus-platform/implementation-sample-front-react.git
cd implementation-sample-front-react
# 環境変数の設定
cp .env.example .env
vi .env
.envファイルで以下の設定を行います：
# SaaSus Platform管理コンソールで取得したログインURLを設定
REACT_APP_LOGIN_URL=https://auth.xxxxxxxxxx.com
# 依存関係のインストール
npm install
# 開発サーバーの起動
npm start
3. バックエンドのセットアップ
各言語のリポジトリから適切なものを選択してセットアップしてください。 詳細なセットアップ手順は各リポジトリのREADMEをご参照ください：
4. 動作確認
- フロントエンドにアクセス
- ログイン機能の動作確認
- 各機能の動作確認
その他の実装方式
サーバーレス版の実装については、以下のドキュメントをご参照ください：