From 644087fb1c67f2727e2c93406ab9c56241249251 Mon Sep 17 00:00:00 2001 From: sohee6989 <144779368+sohee6989@users.noreply.github.com> Date: Fri, 23 Jan 2026 21:52:46 +0900 Subject: [PATCH 1/2] =?UTF-8?q?=EB=A6=AC=EB=93=9C=EB=AF=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 83 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 175bfc99b..5dc90f5b6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,83 @@ -# Cherrish-Android -Cherrish 안드로이드 레포지토리입니다 🍒 +# logo + +

+ image +

+ +# Cherrish 서비스 소개 +> 미용 의료부터 관리 루틴까지, 개인의 추구미에 맞는 관리의 방향을 정리하고, 다운타임&일정 중복을 방지하는 뷰티 캘린더 + + +
+ +## Cherrish 주요 기능 +- 피부 고민 키워드 기반 시술 리스트 +- 시술 다운타임 설정 및 디데이 여유기간 시각화 +- AI가 짜주는 챌린지 루틴 추천 +- 챌린지 기반 체리 게이미피케이션 + + +
+ +## Tech Stack + +| Category | Stack | +| --- | --- | +| **Architecture** | Google Recommended App Architecture | +| **UI** | Jetpack Compose | +| **DI** | Dagger-Hilt | +| **Asynchronous** | Kotlin Coroutine, Flow | +| **Modularization** | Android App Modularization | +| **Build Configuration** | Gradle Version Catalog, Custom Convention Plugins | + +
+ +## **Convention** + +💫 [Git & Branch Convention](https://alpine-marten-2ce.notion.site/2d5fe06db52581d099b6cb0fa89a4c62?pvs=74)
+✍️ [Code Convention](https://lively-mars-3b7.notion.site/Issue-PR-Convention-216ab823e68d803ba888cf3702831e2f?source=copy_link)
+📂 [Packaging Convention](https://alpine-marten-2ce.notion.site/2d5fe06db525810f8a53ccbb507fbd0b?pvs=74)
+ +
+ +## Contributors + +| 🤴김나현
[@nhyeonii](https://github.com/nhyeonii) | 🍒정소희
[@sohee6989](https://github.com/sohee6989) | 🍒남궁혜민
[@hyeminililo](https://github.com/hyeminililo) | 🍒유수현
[@usuuhyn](https://github.com/usuuhyn) | +| --- | --- | --- | --- | +| | | | | | +| `캘린더` | `홈` `온보딩` | `챌린지` `마이` | `시술` | + +
+ +## **Foldering** +``` +📂 cherrish +┣ 📂 core +┃ ┣ 📂 common +┃ ┣ 📂 designsystem +┃ ┣ 📂 local +┃ ┣ 📂 network +┃ ┣ 📂 util +┣ 📂 data +┃ ┣ 📂 di +┃ ┣ 📂 local +┃ ┣ 📂 model +┃ ┣ 📂 remote +┃ ┣ 📂 repository +┃ ┣ 📂 repositoryimpl +┣ 📂 presentation +┃ ┣ 📂 calendar +┃ ┣ 📂 challenge +┃ ┣ 📂 home +┃ ┣ 📂 main +┃ ┣ 📂 mypage +┃ ┣ 📂 onboarding +┃ ┣ 📂 splash + +``` + +--- + +

+ Made with by Cherrish +

From f5e70bd9ced85f4c9f391a1cc8034a55023f9730 Mon Sep 17 00:00:00 2001 From: sohee6989 <144779368+sohee6989@users.noreply.github.com> Date: Fri, 23 Jan 2026 21:58:26 +0900 Subject: [PATCH 2/2] update --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5dc90f5b6..b2542fa5e 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,16 @@
-## Cherrish 주요 기능 +## Cherrish 주요 기능 - 피부 고민 키워드 기반 시술 리스트 - 시술 다운타임 설정 및 디데이 여유기간 시각화 - AI가 짜주는 챌린지 루틴 추천 - 챌린지 기반 체리 게이미피케이션 - +
-## Tech Stack +## Tech Stack | Category | Stack | | --- | --- | @@ -27,12 +27,31 @@ | **UI** | Jetpack Compose | | **DI** | Dagger-Hilt | | **Asynchronous** | Kotlin Coroutine, Flow | -| **Modularization** | Android App Modularization | +| **Modularization** | Single Modularization | | **Build Configuration** | Gradle Version Catalog, Custom Convention Plugins |
-## **Convention** +### Tech Stack 소개 ### + +**1️⃣ Architecture: Google Recommended App Architecture**
+구글 권장 아키텍처는 UI–상태–비즈니스 로직–데이터를 명확히 분리하여 코드의 책임을 분명하게 만들기 위해 사용했다. +이 구조는 테스트와 유지보수를 쉽게 하고 기능이 커져도 안정적으로 확장할 수 있다고 판단했다. +또한 Android Jetpack(ViewModel, Flow, Compose 등)과 자연스럽게 연동되어 공식 가이드와의 일관성을 유지할 수 있어 선택하였다. + +**2️⃣ Pattern: MVVM**
+러닝커브가 조금 높은 MVI를 적용하기보다 MVVM을 조금 더 체계적으로 사용해보고자 도입했습니다. + +**3️⃣ Dependency Injection: Hilt**
+의존성 주입으로 뷰모델 관리를 더욱 편하게 하고자 도입했습니다. +구글이 공식 지원하는 DI 라이브러리로 보일러플레이트 코드를 최소화할 수 있습니다. + +**4️⃣ Navigation: Type-Safety Navigation**
+기존 문자열 기반 네비게이션은 런타임 오류를 유발할 수 있기 때문에 타입 안정성을 지원하는 Type-Safety Navigation을 도입했습니다. + +
+ +## **Convention** 💫 [Git & Branch Convention](https://alpine-marten-2ce.notion.site/2d5fe06db52581d099b6cb0fa89a4c62?pvs=74)
✍️ [Code Convention](https://lively-mars-3b7.notion.site/Issue-PR-Convention-216ab823e68d803ba888cf3702831e2f?source=copy_link)
@@ -40,7 +59,7 @@
-## Contributors +## Contributors | 🤴김나현
[@nhyeonii](https://github.com/nhyeonii) | 🍒정소희
[@sohee6989](https://github.com/sohee6989) | 🍒남궁혜민
[@hyeminililo](https://github.com/hyeminililo) | 🍒유수현
[@usuuhyn](https://github.com/usuuhyn) | | --- | --- | --- | --- | @@ -49,7 +68,7 @@
-## **Foldering** +## **Foldering** ``` 📂 cherrish ┣ 📂 core