Skip to content

Commit 2b1fca2

Browse files
authored
docs: README.md
1 parent fef80da commit 2b1fca2

File tree

1 file changed

+121
-0
lines changed

1 file changed

+121
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# TnT (Trainer & Trainee)
2+
3+
> νŠΈλ ˆμ΄λ„ˆ, νŠΈλ ˆμ΄λ‹ˆλ₯Ό μœ„ν•œ PT 톡합 관리 μ„œλΉ„μŠ€
4+
5+
<img width="1200" height="801" alt="TnT 1" src="https://github.com/user-attachments/assets/7f6441fb-82bb-4967-8d8f-7f1fcced6790" />
6+
7+
<img width="2267" height="3792" alt="TnT 2" src="https://github.com/user-attachments/assets/b9b6fa22-a53a-4e16-9ca1-613ede2fa925" />
8+
9+
## πŸ› οΈ Spec
10+
- `Clean Architecture`
11+
- `MVI`
12+
- `Hilt`
13+
- `Coroutines`
14+
- `Jetpack Compose`
15+
- `Retrofit2`
16+
- `DataStore`
17+
- `Serialization`
18+
- `Coil`
19+
- `FCM`
20+
- `Ktlint`, `Detekt`
21+
22+
## πŸš™ Navigation Structure
23+
```mermaid
24+
flowchart TD
25+
Login[Login]
26+
RoleSelection[RoleSelection]
27+
28+
TraineeSignUp[TraineeSignUp]
29+
TrainerSignUp[TrainerSignUp]
30+
31+
TraineeConnect[TraineeConnect]
32+
TrainerInvite[TrainerInvite]
33+
TrainerConnect[TrainerConnect]
34+
35+
TraineeMain[TraineeMain]
36+
TrainerMain[TrainerMain]
37+
38+
subgraph "Trainee Routes"
39+
TraineeHome[TraineeMainTab.Home]
40+
TraineeMyPage[TraineeMainTab.MyPage]
41+
TraineeMealRecord[TraineeMealRecord]
42+
TraineeMealDetail[TraineeMealDetail]
43+
end
44+
45+
subgraph "Trainer Routes"
46+
TrainerHome[TrainerMainTab.Home]
47+
TrainerMembers[TrainerMainTab.Members]
48+
TrainerFeedback[TrainerMainTab.Feedback]
49+
TrainerMyPage[TrainerMainTab.MyPage]
50+
AddPtSession[AddPtSession]
51+
end
52+
53+
Login --> RoleSelection
54+
RoleSelection --> TraineeSignUp
55+
RoleSelection --> TrainerSignUp
56+
57+
TraineeSignUp --> TraineeConnect
58+
TraineeConnect --> TraineeMain
59+
60+
TrainerSignUp --> TrainerInvite
61+
TrainerConnect --> TrainerMain
62+
63+
TrainerInvite --> TrainerMain
64+
65+
TraineeMain --> TraineeHome
66+
TraineeMain --> TraineeMyPage
67+
TraineeHome --> TraineeMealRecord
68+
TraineeMealRecord --> TraineeMealDetail
69+
70+
TrainerMain --> TrainerHome
71+
TrainerMain --> TrainerMembers
72+
TrainerMain --> TrainerFeedback
73+
TrainerMain --> TrainerMyPage
74+
TrainerHome --> AddPtSession
75+
```
76+
77+
78+
## πŸ“¦ Package Structure
79+
```
80+
App
81+
β”œβ”€β”€ build-logic/
82+
β”œβ”€β”€ domain/
83+
β”œβ”€β”€ data/
84+
β”‚ β”œβ”€β”€ network/
85+
β”‚ β”œβ”€β”€ storage/
86+
β”‚ β”œβ”€β”€ repository/
87+
β”‚ └── session/
88+
β”œβ”€β”€ core/
89+
β”‚ β”œβ”€β”€ designsystem/
90+
β”‚ β”œβ”€β”€ navigation/
91+
β”‚ β”œβ”€β”€ ui/
92+
β”‚ └── login/
93+
β”œβ”€β”€ feature/
94+
β”‚ β”œβ”€β”€ main/
95+
β”‚ β”œβ”€β”€ login/
96+
β”‚ β”œβ”€β”€ roleselect/
97+
β”‚ β”œβ”€β”€ webview/
98+
β”‚ β”œβ”€β”€ trainer/
99+
β”‚ β”‚ β”œβ”€β”€ signup/
100+
β”‚ β”‚ β”œβ”€β”€ connect/
101+
β”‚ β”‚ β”œβ”€β”€ invite/
102+
β”‚ β”‚ β”œβ”€β”€ main/
103+
β”‚ β”‚ β”œβ”€β”€ home/
104+
β”‚ β”‚ β”œβ”€β”€ feedback/
105+
β”‚ β”‚ β”œβ”€β”€ members/
106+
β”‚ β”‚ β”œβ”€β”€ mypage/
107+
β”‚ β”‚ β”œβ”€β”€ notification/
108+
β”‚ β”‚ β”œβ”€β”€ addptsession/
109+
β”‚ β”‚ └── modifymyinfo/
110+
β”‚ └── trainee/
111+
β”‚ β”œβ”€β”€ signup/
112+
β”‚ β”œβ”€β”€ connect/
113+
β”‚ β”œβ”€β”€ main/
114+
β”‚ β”œβ”€β”€ home/
115+
β”‚ β”œβ”€β”€ mypage/
116+
β”‚ β”œβ”€β”€ notification/
117+
β”‚ β”œβ”€β”€ mealrecord/
118+
β”‚ └── mealdetail/
119+
└── gradle/
120+
└── libs.versions.toml
121+
```

0 commit comments

Comments
Β (0)