Skip to content

Latest commit

 

History

140 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

booking-backend ドキュメント一覧

ドキュメント情報

  • 目的: docs/ 配下のドキュメントの役割と読書動線を一枚で示す。

画面ギャラリー

メール通知テンプレート

予約の確定・更新・キャンセル時に送信される HTML メールのレンダリング例です。

予約確定(Booking Confirmed)

予約確定メールのレンダリング例

予約更新(Booking Updated)

予約更新メールのレンダリング例

予約キャンセル(Booking Cancelled)

予約キャンセルメールのレンダリング例

推奨読書動線

順 ドキュメント 一言説明
1 api-contract.md エンドポイント単位の API 契約。フロント/バック統合の single source of truth(server-to-server の IF-01/IF-02 は対象外)。
2 sequence-diagrams/01〜05 全 43 業務シナリオを 5 つのシーケンス図で網羅。処理フローとコード根拠(file:line)を図で追う。
3 scenario-deep-dive.md 競合系・認可系の代表 3 シナリオ(P2034 再試行 / P2034 枯渇・P2002 / 非所有者キャンセル 404)を処理フロー・コード根拠・検証コマンド付きで深掘り。
4 redis-usage-and-schema.md Redis の接続方法・キー schema・用途別詳細(トークンブラックリスト / SMS 検証コード / ヘルスチェック)。
5 manual-retry-procedure.md Salesforce 連携(IF-02 コマンド系 / IF-01 投影系)の失敗・滞留時の手動リトライ運用手順書。

シーケンス図の構成

全 43 業務シナリオを 5 つのシーケンス図で網羅する。各図は「ビジネスシナリオ一覧 + シナリオ別解説 + Participant evidence(コード根拠)」で構成する。

図 対象フロー シナリオ数
01 認証(send-code / login / register → JWT 発行) 7
02 サービス・時間枠発見(3 つの GET フローと状態合成) 6
03 予約作成(POST /bookings、Serializable トランザクション) 10
04 予約キャンセル(PATCH /bookings/:id/cancel) 8
05 JWT ガード + axios 401 自動リフレッシュ 12
計 — 43

関連リポジトリ

ドキュメント追加・更新の規約

  • .gitignore は docs/ を既定で無視するため、バージョン管理対象のドキュメントは !/docs/... の whitelist に追加する。
  • file:line アンカーは commit 時点の grep -n 実測値で記載し、ソース変更後は再実測で更新する(原文の行号を流用しない)。
  • ソースコード内のエラーメッセージは翻訳せず中国語 literal のまま引用し、必要に応じて(※コード内のメッセージ literal)を注記する。

🌍 日本語 | English | 中文

About

CRM Booking Platform Backend built with NestJS, PostgreSQL and Redis

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages