作業履歴 2025-06-09¶
概要¶
2025-06-09の作業内容をまとめています。このジャーナルでは、プロジェクトのドキュメント改善、特にREADMEファイルの更新と構造化に関する作業を記録しています。
ドキュメント構造図¶
作業内容¶
ドキュメント改善¶
プロジェクトの理解と利用を容易にするため、READMEファイルの大幅な改善を行いました。特に、Quick Start手順の追加、仕様セクションの拡充、および全体構造の整理に焦点を当てました。
変更点の概要¶
- Quick Start手順の追加（Docker環境での起動方法）
- 仕様セクションの追加（基本仕様、ユースケース、コアモデル）
- 構成セクションの整理と更新
- 古い環境構築手順の削除（Vagrant関連）
- CI/CD関連の記述をCircleCIからGitHub Actionsに更新
コミット: cf20bcc¶
メッセージ¶
docs:README更新
変更されたファイル¶
- M README.md
変更内容¶
commit cf20bcce37bd0563a0a982c777a6f67a2eb6a428
Author: k2works <kakimomokuri@gmail.com>
Date: Mon Jun 9 09:40:28 2025 +0900
docs:README更新
diff --git a/README.md b/README.md
index ce5f121..5406c95 100644
--- a/README.md
+++ b/README.md
@@ -14,16 +14,28 @@ Rails5からRails7にアップグレードする
| rails | 7.2.2.1 | |
| docker | 28.1.1 | |
+# Quick Start #
+
+```
+docker build -t app:base .
+docker compose build
+docker compose up -d
+```
+
+http://127.0.0.1:3000 にアクセスして、アプリケーションが起動していることを確認してください。
+
# 構成 #
+1. [仕様](#仕様)
+ 1. [基本仕様](#基本仕様)
+ 1. [ユースーケース](#ユースーケース)
+ 1. [コアモデル](#コアモデル)
1. [アプリケーション環境構築](#アプリケーション環境構築)
- 1. [Vagarntのセットアップ](#Vagarntのセットアップ)
- 1. [Dockerのセットアップ](#Dockerのセットアップ)
1. [追加Gemセットアップ](#追加Gemセットアップ)
1. [その他の準備作業](#その他の準備作業)
1. [テスト環境のセットアップ](#テスト環境のセットアップ)
1. [アプリケーション配置](#アプリケーション配置)
1. [Herokuセットアップ](#Herokuセットアップ)
- 1. [CircleCIセットアップ](#CircleCIセットアップ)
+ 1. [GitHubActionセットアップ](#CircleCIセットアップ)
1. [アプリケーション開発](#アプリケーション開発)
1. [ビジュアルデザイン](#ビジュアルデザイン)
1. [エラーページ](#エラーページ)
@@ -42,15 +54,142 @@ Rails5からRails7にアップグレードする
1. [フォームオブジェクト](#フォームオブジェクト)
1. [検索フォーム](#検索フォーム)
-## アプリケーション環境構築
-
-### Dockerのセットアップ
+## 仕様
+
+## 基本仕様
++ システムの利用者は、職員（staff members）と管理者（administrators）と顧客（customers）に分類される。
++ 職員は顧客の一覧を表示したり、特定の条件で顧客を抽出できる。
++ 職員は顧客の情報を追加・更新・削除できる。
++ 職員はタイトル、申込み開始日次、最大参加者数などを指定してプログラムを登録できる。
++ 管理者は職員を登録・更新・削除することができる。
++ 管理者は職員のログイン・ログアウト履歴を閲覧できる。
++ 顧客にはログイン用のアカウントが発行されている。
++ 顧客は企業への問い合わせを一覧表示できる。
++ 顧客は企業への問い合わせを検索できる。
++ 顧客は自分自身の個人情報を閲覧・修正できる。
++ 顧客はプログラム一覧から参加申し込みできる。
+
+## ユースーケース
+```mermaid
+flowchart LR
+ 管理者((管理者))
+ 職員((職員))
+ 顧客((顧客))
+
+ subgraph Baukis["Baukis"]
+ 認証["認証"]
+ 職員アカウント管理["職員アカウント管理"]
+ 職員のログインログアウト管理["職員のログイン・ログアウト管理"]
+ 顧客アカウント管理["顧客アカウント管理"]
+ プログラムの管理["プログラムの管理"]
+ 問い合わせ管理["問い合わせ管理"]
+ プログラムの申込み["プログラムの申込み"]
+ 問い合わせ["問い合わせ"]
+ end
+
+ %% 管理者の関連
+ 管理者 --- 認証
+ 管理者 --- 職員アカウント管理
+ 管理者 --- 職員のログインログアウト管理
+
+ %% 職員の関連
+ 職員 --- 認証
+ 職員 --- 職員アカウント管理
+ 職員 --- 顧客アカウント管理
+ 職員 --- プログラムの管理
+ 職員 --- 問い合わせ管理
+
+ %% 顧客の関連
+ 顧客 --- 認証
+ 顧客 --- プログラムの申込み
+ 顧客 --- 問い合わせ
+ 顧客 --- 顧客アカウント管理
```
-docker build -t app:base .
-docker compose build
-docker compose up -d
+
+## コアモデル
+```mermaid
+classDiagram
+ Administrator --|> StaffMember
+ StaffMember --o Customer
+StaffMember "1" o-- "0..*" StaffEvent
+StaffMember "1" o-- "0..*" Program
+StaffMember "1" *-- "1..*" Message
+Program "1" *-- "0..*" StaffEvent
+Customer "1" *-- "1..*" Address
+Customer "1" *-- "1..*" Phone
+Customer "1" *-- "1..*" Message
+Customer "1" o-- "0..*" StaffEvent
+Customer "1" o-- "0..*" Program
+Address <|-- HomeAddress
+Address <|-- WorkAddress
+Phone <|-- PersonalPhone
+Message <|-- InboundMessage
+Message <|-- OutboundMessage
+
+class Administrator {
++id: int
++name: string
+ }
+
+class StaffMember {
++id: int
++name: string
+ }
+
+class Customer {
++id: int
++name: string
+ }
+
+class StaffEvent {
++id: int
++event_type: string
+ }
+
+class Program {
++id: int
++title: string
+ }
+
+class Message {
++id: int
++content: string
+ }
+
+class Address {
++id: int
++street: string
+ }
+
+class Phone {
++id: int
++number: string
+ }
+
+class HomeAddress {
++home_specific_field: string
+}
+
+class WorkAddress {
++work_specific_field: string
+}
+
+class PersonalPhone {
++personal_specific_field: string
+}
+
+class InboundMessage {
++received_at: datetime
+}
+
+class OutboundMessage {
++sent_at: datetime
+}
```
+
+## アプリケーション環境構築
+
### 追加Gemセットアップ
### その他の準備作業
@@ -74,7 +213,7 @@ heroku create baukis-kai
git push heroku master
```
-### CircleCIセットアップ
+### GitHubActionセットアップ
**[⬆ back to top](#構成)**
## アプリケーション開発