From eff3708dbd82aeea1cfabde2213e5a1a9e870739 Mon Sep 17 00:00:00 2001
From: Yeji Kim <135138918+apffkxhsls@users.noreply.github.com>
Date: Fri, 17 Jul 2026 13:27:01 +0900
Subject: [PATCH] =?UTF-8?q?[docs/#194]=20README=20=EC=9E=91=EC=84=B1?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 89 +++++++++++++++++++++++++++++++++++++------------------
1 file changed, 60 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
index d3ff1abc..196ecb28 100644
--- a/README.md
+++ b/README.md
@@ -4,36 +4,36 @@
강사와 수강생을 빠르고 합리적인 구조로 연결하는 원클릭 매칭 플랫폼으로,
즉시 강습부터 사전 예약까지 다양한 방식으로 나에게 맞는 강습을 시작할 수 있습니다.
-스키장 현장에서 준비된 강사와 실시간으로 연결되어, 기다림 없이 바로 강습을 시작해보세요!
+스키장 현장에서 준비된 강사와 실시간으로 연결되어, 기다림 없이 바로 강습을 시작해보세요!
## 💙 Contributors
-| 🏂한유빈 (LEAD)
[@oilbeaneda](https://github.com/oilbeaneda) | 🏂전도연
[@doyeon0307](https://github.com/doyeon0307) | 🏂조예슬
[@joyrii](https://github.com/joyrii) | 🏂김예지
[@apffkxhsls](https://github.com/apffkxhsls) | 🏂김예림
[@doorimng](https://github.com/doorimng) |
-|:---:|:---:|:---:|:---:|:---:|
-|
|
|
|
|
|
-| `강사 매칭 플로우`,
`알림`, `기초 세팅` | `소비자매칭 플로우`,
`WebSocket 세팅` | `소비자강습상세`,
`DS 세팅` | `강사 강습상세`,
`FCM 세팅` | `카카오 로그인`,
`홈`, `강습 확정`,
`결제` |
+| 🏂한유빈 (LEAD)
[@oilbeaneda](https://github.com/oilbeaneda) | 🏂전도연
[@doyeon0307](https://github.com/doyeon0307) | 🏂조예슬
[@joyrii](https://github.com/joyrii) | 🏂김예지
[@apffkxhsls](https://github.com/apffkxhsls) | 🏂김예림
[@doorimng](https://github.com/doorimng) |
+|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|
+|
|
|
|
|
|
+| `강사 매칭 플로우`,
`알림`, `기초 세팅` | `소비자 매칭 플로우`,
`WebSocket 세팅` | `소비자 강습상세`,
`DS 세팅` | `강사 강습상세`,
`FCM 세팅` | `카카오 로그인`,
`홈`, `강습 확정`,
`결제` |
## ⚒️ Tech Stacks
-| 항목 | 기술 스택 |
-| :--- | :--- |
-| Architecture | Google Recommended Architecture (Domain 제거) |
-| Pattern | MVVM + Contract (MVI Intent 제거) |
-| Modularization | Android Multi-Module + Convention Plugin |
-| DI | Hilt |
-| Asynchronous | Coroutine, Flow |
-| Network | Retrofit2, OkHttp |
-| Real-time | WebSocket |
-| Notification | FCM |
-| Navigation | Jetpack Navigation (Type-safe) |
-| UI Framework | Jetpack Compose |
-| Image | Coil |
-| Logging | Timber |
-| Local Storage | DataStore |
+| 항목 | 기술 스택 |
+|:---------------|:--------------------------------------------|
+| Architecture | Google Recommended Architecture (Domain 제거) |
+| Pattern | MVVM + Contract (MVI Intent 제거) |
+| Modularization | Android Multi-Module + Convention Plugin |
+| DI | Hilt |
+| Asynchronous | Coroutine, Flow |
+| Network | Retrofit2, OkHttp |
+| Real-time | WebSocket |
+| Notification | FCM |
+| Navigation | Jetpack Navigation (Type-safe) |
+| UI Framework | Jetpack Compose |
+| Image | Coil |
+| Logging | Timber |
+| Local Storage | DataStore |
@@ -47,17 +47,28 @@
│ └── 📁 instructor # 강사 앱
│
├── 📂 presentation
-│ ├── 📁 auth
+│ ├── 📁 auth
+│ ├── 📁 devauth
│ ├── 📁 notification
-│ ├── 📁 consumer-home
+│ ├── 📁 consumer-home
+│ ├── 📁 consumer-lesson
+│ ├── 📁 consumer-profile
│ ├── 📁 consumer-matching
-│ ├── 📁 consumer-payment
-│ ├── 📁 consumer-lesson
-│ ├── 📁 instructor-home
-│ └── 📁 instructor-matching
+│ ├── 📁 consumer-payment
+│ ├── 📁 instructor-home
+│ ├── 📁 instructor-lesson
+│ ├── 📁 instructor-profile
+│ └── 📁 instructor-matching
+│ └── 📁 navigation
│
├── 📂 data # 단일 모듈, feature별 패키지
│ ├── 📁 di # 의존성 주입 모듈
+│ ├── 📁 auth
+│ ├── 📁 devauth
+│ ├── 📁 home
+│ ├── 📁 lesson
+│ ├── 📁 notification
+│ ├── 📁 payment
│ └── 📁 matching
│ ├── 📁 model
│ ├── 📁 remote
@@ -68,23 +79,43 @@
└── 📂 core
├── 📂 ui
│ ├── 📁 base # BaseViewModel
- │ ├── 📁 designsystem # 색상, 타이포, 테마, 공통 컴포넌트
+ │ ├── 📁 common # 공통 컴포넌트
+ │ ├── 📁 designsystem # 색상, 타이포, 테마
│ ├── 📁 extension # Kotlin 확장 함수
│ ├── 📁 navigation # Route 인터페이스
+ │ ├── 📁 state
+ │ ├── 📁 type
│ └── 📁 util # 공통 유틸
├── 📂 network # Retrofit + OkHttp + WebSocket
+ │ ├── 📁 authenticator
+ │ ├── 📁 constant
│ ├── 📁 di
+ │ ├── 📁 dto
+ │ ├── 📁 exception
+ │ ├── 📁 extension
+ │ ├── 📁 interceptor
│ ├── 📁 model
+ │ ├── 📁 service
+ │ ├── 📁 session
+ │ ├── 📁 socket
+ │ ├── 📁 token
│ └── 📁 util
+ ├── 📂 notification
+ │ └── 📁 data
+ │ ├── 📁 di
+ │ ├── 📁 remote
+ │ └── 📁 repository
+ │
└── 📂 localstorage # DataStore (토큰 저장)
- └── 📁 di
+ └── 📁 datastore
+ └── 📁 di
```
## 📐 Module Dependency Graph
-
+