Skip to content

Commit 2fac41e

Browse files
committed
#74 update README
1 parent b517315 commit 2fac41e

8 files changed

Lines changed: 69 additions & 101 deletions

File tree

template/electron/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ Directory for Electron configuration used to build desktop applications for Wind
66

77
## ディレクトリ構造 / Directory Structure
88

9-
```mermaid
10-
graph LR
11-
subgraph electron["electron/"]
12-
icons["icons/<br>アプリケーションアイコン"]
13-
index["index.js<br>メインプロセス"]
14-
package["package.json<br>依存関係"]
15-
end
9+
```
10+
electron/
11+
├── icons/ # アプリケーションアイコン
12+
├── index.js # メインプロセス
13+
└── package.json # 依存関係
1614
```
1715

1816
## ファイル説明 / File Description

template/src/model/application/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ The Application layer provides business logic corresponding to user actions. Thi
1919

2020
## ディレクトリ構造 / Directory Structure
2121

22-
```mermaid
23-
graph LR
24-
subgraph application["application/"]
25-
subgraph home["home/"]
26-
home_usecase["usecase/<br>StartDragUseCase.js<br>StopDragUseCase.js<br>CenterTextFieldUseCase.js"]
27-
end
28-
subgraph top["top/"]
29-
top_usecase["usecase/<br>NavigateToViewUseCase.js"]
30-
end
31-
end
22+
```
23+
application/
24+
├── home/
25+
└── usecase/
26+
├── StartDragUseCase.js
27+
├── StopDragUseCase.js
28+
└── CenterTextFieldUseCase.js
29+
└── top/
30+
└── usecase/
31+
└── NavigateToViewUseCase.js
3232
```
3333

3434
各画面ごとにディレクトリを作成し、その中に `usecase` ディレクトリを配置します。

template/src/model/domain/README.md

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,42 +20,31 @@ The Domain layer holds the core business rules of the application. This layer ha
2020

2121
## ディレクトリ構造 / Directory Structure
2222

23-
```mermaid
24-
graph LR
25-
subgraph domain["domain/"]
26-
subgraph callback["callback/"]
27-
subgraph Background["Background/"]
28-
bg["Background.js"]
29-
subgraph service["service/"]
30-
draw["BackgroundDrawService.js"]
31-
scale["BackgroundChangeScaleService.js"]
32-
end
33-
end
34-
end
35-
end
23+
```
24+
domain/
25+
└── callback/
26+
└── Background/
27+
├── Background.js
28+
└── service/
29+
├── BackgroundDrawService.js
30+
└── BackgroundChangeScaleService.js
3631
```
3732

3833
将来的に以下のような拡張も可能です:
3934

4035
Future extensions are possible, such as:
4136

42-
```mermaid
43-
graph LR
44-
subgraph domain["domain/"]
45-
subgraph callback["callback/<br>コールバック処理"]
46-
bg["Background/"]
47-
end
48-
subgraph service["service/<br>ドメインサービス"]
49-
validation["ValidationService.js"]
50-
calculation["CalculationService.js"]
51-
end
52-
subgraph entity["entity/<br>エンティティ"]
53-
user["User.js"]
54-
end
55-
subgraph value["value-object/<br>値オブジェクト"]
56-
email["Email.js"]
57-
end
58-
end
37+
```
38+
domain/
39+
├── callback/ # コールバック処理
40+
│ └── Background/
41+
├── service/ # ドメインサービス
42+
│ ├── ValidationService.js
43+
│ └── CalculationService.js
44+
├── entity/ # エンティティ
45+
│ └── User.js
46+
└── value-object/ # 値オブジェクト
47+
└── Email.js
5948
```
6049

6150
## ドメインの概念 / Domain Concepts

template/src/model/infrastructure/README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,24 @@ The Infrastructure layer is responsible for interactions with the outside of the
1919

2020
## ディレクトリ構造 / Directory Structure
2121

22-
```mermaid
23-
graph LR
24-
subgraph infrastructure["infrastructure/"]
25-
subgraph repository["repository/"]
26-
home["HomeTextRepository.js"]
27-
end
28-
end
22+
```
23+
infrastructure/
24+
└── repository/
25+
└── HomeTextRepository.js
2926
```
3027

3128
将来的に以下のような拡張も可能です:
3229

3330
Future extensions are possible, such as:
3431

35-
```mermaid
36-
graph LR
37-
subgraph infrastructure["infrastructure/"]
38-
subgraph repository["repository/<br>データアクセス層"]
39-
home["HomeTextRepository.js"]
40-
user["UserRepository.js"]
41-
config["ConfigRepository.js"]
42-
end
43-
subgraph external["external/<br>外部サービス"]
44-
analytics["AnalyticsService.js"]
45-
end
46-
end
32+
```
33+
infrastructure/
34+
├── repository/ # データアクセス層
35+
│ ├── HomeTextRepository.js
36+
│ ├── UserRepository.js
37+
│ └── ConfigRepository.js
38+
└── external/ # 外部サービス
39+
└── AnalyticsService.js
4740
```
4841

4942
## Repository Pattern

template/src/ui/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,13 @@ Directory for storing UI components, structured based on Atomic Design principle
66

77
## ディレクトリ構造 / Directory Structure
88

9-
```mermaid
10-
graph LR
11-
subgraph ui["ui/"]
12-
animation["animation/<br>アニメーション定義"]
13-
subgraph component["component/"]
14-
atom["atom/<br>最小単位"]
15-
molecule["molecule/<br>複合コンポーネント"]
16-
end
17-
content["content/<br>Animation Tool"]
18-
end
9+
```
10+
ui/
11+
├── animation/ # アニメーション定義
12+
├── component/
13+
│ ├── atom/ # 最小単位
14+
│ └── molecule/ # 複合コンポーネント
15+
└── content/ # Animation Tool
1916
```
2017

2118
## アトミックデザインの階層 / Atomic Design Hierarchy

template/src/ui/animation/README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ Separating animation definitions from components improves code reusability and m
1212

1313
## ディレクトリ構造 / Directory Structure
1414

15-
```mermaid
16-
graph LR
17-
subgraph animation["animation/"]
18-
subgraph top["top/"]
19-
entrance["TopBtnEntranceAnimation.js"]
20-
end
21-
end
15+
```
16+
animation/
17+
└── top/
18+
└── TopBtnEntranceAnimation.js
2219
```
2320

2421
画面ごとにサブディレクトリを作成し、その中にアニメーション定義ファイルを配置します。

template/src/ui/component/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,14 @@ Directory for UI components based on Atomic Design principles.
66

77
## ディレクトリ構造 / Directory Structure
88

9-
```mermaid
10-
graph LR
11-
subgraph component["component/"]
12-
subgraph atom["atom/<br>最小単位"]
13-
button["ButtonAtom.js"]
14-
text["TextAtom.js"]
15-
end
16-
subgraph molecule["molecule/<br>複合コンポーネント"]
17-
homeBtn["HomeBtnMolecule.js"]
18-
topBtn["TopBtnMolecule.js"]
19-
end
20-
end
9+
```
10+
component/
11+
├── atom/ # 最小単位
12+
│ ├── ButtonAtom.js
13+
│ └── TextAtom.js
14+
└── molecule/ # 複合コンポーネント
15+
├── HomeBtnMolecule.js
16+
└── TopBtnMolecule.js
2117
```
2218

2319
## アトミックデザイン階層 / Atomic Design Hierarchy

template/src/ui/content/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@ Wraps animations created with the Animation Tool as JavaScript classes for use i
1212

1313
## ディレクトリ構造 / Directory Structure
1414

15-
```mermaid
16-
graph LR
17-
subgraph content["content/"]
18-
home["HomeContent.js<br>Home画面用"]
19-
top["TopContent.js<br>Top画面用"]
20-
end
15+
```
16+
content/
17+
├── HomeContent.js # Home画面用
18+
└── TopContent.js # Top画面用
2119
```
2220

2321
## コンテンツの仕組み / How Content Works

0 commit comments

Comments
 (0)