Skip to content

[DOCS/#194] README 작성 #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apffkxhsls merged 1 commit into from
Jul 17, 2026
Merged

[DOCS/#194] README 작성 #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 60 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@

강사와 수강생을 빠르고 합리적인 구조로 연결하는 원클릭 매칭 플랫폼으로,
즉시 강습부터 사전 예약까지 다양한 방식으로 나에게 맞는 강습을 시작할 수 있습니다.
스키장 현장에서 준비된 강사와 실시간으로 연결되어, 기다림 없이 바로 강습을 시작해보세요!
스키장 현장에서 준비된 강사와 실시간으로 연결되어, 기다림 없이 바로 강습을 시작해보세요!

<br/>

## 💙 Contributors

| 🏂한유빈 (LEAD)<br/>[@oilbeaneda](https://github.com/oilbeaneda) | 🏂전도연<br/>[@doyeon0307](https://github.com/doyeon0307) | 🏂조예슬<br/>[@joyrii](https://github.com/joyrii) | 🏂김예지<br/>[@apffkxhsls](https://github.com/apffkxhsls) | 🏂김예림<br/>[@doorimng](https://github.com/doorimng) |
|:---:|:---:|:---:|:---:|:---:|
| <img alt="한유빈 avatar" src="https://avatars.githubusercontent.com/oilbeaneda" height="200" /> | <img alt="전도연 avatar" src="https://avatars.githubusercontent.com/doyeon0307" height="200" /> | <img alt="조예슬 avatar" src="https://avatars.githubusercontent.com/joyrii" height="200" /> | <img alt="김예지 avatar" src="https://avatars.githubusercontent.com/apffkxhsls" height="200" /> | <img alt="김예림 avatar" src="https://avatars.githubusercontent.com/doorimng" height="200" /> |
| `강사 매칭 플로우`,<br/> `알림`, `기초 세팅` | `소비자매칭 플로우`,<br/> `WebSocket 세팅` | `소비자강습상세`,<br/> `DS 세팅` | `강사 강습상세`,<br/> `FCM 세팅` | `카카오 로그인`,<br/> `홈`, `강습 확정`,<br/> `결제` |
| 🏂한유빈 (LEAD)<br/>[@oilbeaneda](https://github.com/oilbeaneda) | 🏂전도연<br/>[@doyeon0307](https://github.com/doyeon0307) | 🏂조예슬<br/>[@joyrii](https://github.com/joyrii) | 🏂김예지<br/>[@apffkxhsls](https://github.com/apffkxhsls) | 🏂김예림<br/>[@doorimng](https://github.com/doorimng) |
|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|
| <img alt="한유빈 avatar" src="https://github.com/user-attachments/assets/777d6a78-a17a-4fac-83f7-6c5f4e71cf9c" height="200" /> | <img alt="전도연 avatar" src="https://github.com/user-attachments/assets/e5dae0d2-98b1-4c89-bc61-c14c2ff9d617" height="200" /> | <img alt="조예슬 avatar" src="https://github.com/user-attachments/assets/022fa9b5-a6e9-4059-a9df-0f378cc576fe" height="200" /> | <img alt="김예지 avatar" src="https://github.com/user-attachments/assets/0d2a9981-8303-4c82-a36b-b15d07537987" height="200" /> | <img alt="김예림 avatar" src="https://github.com/user-attachments/assets/c6b03389-963d-4265-a5a0-1fccef83e5e5" height="200" /> |
| `강사 매칭 플로우`,<br/> `알림`, `기초 세팅` | `소비자 매칭 플로우`,<br/> `WebSocket 세팅` | `소비자 강습상세`,<br/> `DS 세팅` | `강사 강습상세`,<br/> `FCM 세팅` | `카카오 로그인`,<br/> `홈`, `강습 확정`,<br/> `결제` |

<br/>

## ⚒️ 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 |

<br/>

Expand All @@ -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
Expand All @@ -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
```

<br/>

## 📐 Module Dependency Graph

<img width="800" alt="SSING Module Dependency" src="https://github.com/user-attachments/assets/c2e3ae4e-3ae9-4e31-a315-3a7771f4645f" />
<img width="800" alt="SSING Module Dependency" src="https://github.com/user-attachments/assets/4f669e02-9afa-4bf3-80e6-2f777c7c4a37" />

<br/>

Expand Down
Loading