メインコンテンツに移動

アーキテクチャ

これらのページはクロスリポジトリのシステムマップです。特定のプロジェクトの設定方法ではなく、ChurchApps の中核となるシステムがアプリ、API モジュール、共有ライブラリ全体にわたってエンドツーエンドでどのように動作するかを説明します。システムの動作を変更する前にお読みください。プロジェクトを起動するにはセットアップを、エンドポイント単位のリファレンスについてはAPI セクションをお読みください。

エコシステムの概要​

ChurchApps は約 20 の独立したリポジトリで構成されています(モノレポではありません)。クライアントアプリは HTTPS および WebSocket を介して少数のバックエンド API と通信し、@churchapps スコープで公開された npm パッケージを通じてコードを共有します。

┌────────────────────────────────┐            ┌──────────────────────────────────────────────┐
│ Clients │ │ Api — core modular monolith (AWS Lambda) │
│ │ │ │
│ B1Admin staff dashboard │ HTTPS │ membership attendance content │
│ B1App member portal + │ ─────────▶ │ giving messaging doing │
│ church websites │ │ │
│ B1Checkin check-in kiosk │ ◀───WS───▶ │ one MySQL database per module (6 total) │
│ │ └──────────────────────────────────────────────┘
│ FreePlay TV content player │ ┌──────────────────────────────────────────────┐
└───────────────┬────────────────┘ │ LessonsApi — Lessons.church backend │
│ └──────────────────────────────────────────────┘
│ shared code via npm (@churchapps/*)
▼
helpers (cross-app interfaces) · apphelper (React components) · apihelper (Express/server utilities)

この章のドキュメント全体を形づくる 2 つの構造的ルールは次のとおりです。

  1. モジュールは分離されています。 各 Api モジュールは自身のデータベースとテーブルを所有し、他のモジュールやアプリは REST エンドポイントを通じてのみそのデータにアクセスします。モジュール構造を参照してください。
  2. 共有コードは npm パッケージとして提供されます。 アプリ同士が互いのソースコードをインポートすることはありません。再利用されるものはすべて @churchapps/helpers、@churchapps/apphelper、@churchapps/apihelper を介してリポジトリの境界を越えます。共有ライブラリを参照してください。

システムマップ​

ページ内容対象範囲
通知とリマインダー誰かに何かを伝える仕組み全体:2 つの配信経路、チャネルのエスカレーションチェーン、リマインダーエンジンApi (messaging), B1Admin, B1App
リアルタイムアーキテクチャチャット、プレゼンス、アプリ内配信を支える WebSocket 配信フレームワークApi (messaging), all web apps
Web プッシュ通知ブラウザのプッシュチャネル:VAPID キー、サブスクリプションの保存、配信Api (messaging), all web apps
寄付決済プロバイダーとゲートウェイ、寄付フロー、基金/バッチ、ゲートウェイの WebhookApi (giving), apphelper, B1App, B1Admin
イベント登録登録の商取引モデル:参加者タイプ、選択項目、割引コード、寄付ゲートウェイを通じた支払い、キャンセル待ちリストApi (content + giving), B1App, B1Admin
チェックインキオスクおよびセルフチェックイン、出席データモデル、ルーム振り分け、児童安全レイヤー、ラベル印刷B1Checkin, B1App, B1Admin, Api (attendance + membership)
ウェブサイトビルダーページ/セクション/要素のツリー、要素タイプの契約とレンダラー、ブログ、アクセス制限付きページ、SEO、AI 生成Api (content), AskApi, helpers/apphelper, B1Admin, B1App
ウェブサイトのルーティングとマルチサイトリクエストが教会と特定のサイトにどのように解決されるか、マルチサイト siteId データモデル、Caddy カスタムドメインのエッジB1App, Api (membership + content), B1Admin
インテグレーション拡張インターフェース:OAuth、API キー、Webhook、コンテンツプロバイダー、MCPApi, shared libraries, external apps
監査ログと取り消し可能なバッチコントローラーの共通処理点でのすべての変更の監査(デフォルトで有効)、およびインポートや一括操作を取り消し可能にするバッチレイヤーApi (all modules), B1Admin, B1Transfer
MinistryStuff有料のストレージおよびテキストメッセージクレジットサービス:共有 JWT による ID、サービスキーによる S2S、テキストメッセージおよびストレージのプロバイダー接続点、Stripe 請求MinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper packages, B1Admin
持ち込みストレージ(BYOS)教会は無料の 100MB を超えるアップロードのために Google Drive、Dropbox、OneDrive、または S3 互換バケットを連携できます:OAuth 接続、プロバイダーごとのアップロード形式、公開ダウンロードリダイレクトApi (content + membership), helpers/apphelper packages, B1Admin, B1App
コンテンツコモンズクロスプロダクトのユーザー生成コンテンツを支える共有のアセット/投稿基盤、および B1Admin Server Admin の単一のスタッフ専用モデレーションキューApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
ヒント

別のアプリ内のページではなく、これらのシステムのいずれかの動作が変わる場合は、対応するシステムマップも同じ作業で更新してください。これにより、このセクションが新しい寄稿者にとって信頼できる最初の情報源であり続けます。

提案​

これらのドキュメントは、利用可能な製品の動作ではなく、レビュー用に提案された作業内容を説明しています。

提案内容
Twilio BYOK教会所有のアカウント、キー、サービス、電話番号。連携の範囲、同意、配信、見積もり、リリースチェック
Twilio 教会オンボーディングの草案提案された B1 サインアップフォームの設定、教会固有のキャンペーン例、承認/運用チェックリスト