From c9e8c3143b1a54bc93c2c1ceaf1bada31734f732 Mon Sep 17 00:00:00 2001 From: Dowoo Kim <109224863+KDW03@users.noreply.github.com> Date: Tue, 31 Oct 2023 16:43:47 +0900 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index ce2b604b..99b3284f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ ![image](https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/91100610-2cfa-434c-9cb9-c5ecaf106e13) +
+
+ ## ๐ŸŒธ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ ์†Œ์ค‘ํ•œ ์—ฐ์ธ๊ณผ์˜ ์ถ”์–ต์„ ๊ธฐ๋กํ•ด ๋ณด์„ธ์š” ๐Ÿฅฐ @@ -11,6 +14,10 @@ ์œ„์น˜์™€ ๋‚ ์งœ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ์ถ”์–ต์„ ๋ชจ์•„๋ณผ ์ˆ˜ ์žˆ์–ด์š” โ˜บ +
+
+ + ## ๐Ÿ‘ฉโ€๐Ÿ’ป ๊ฐœ๋ฐœ์ž
@@ -21,6 +28,11 @@
+ +
+
+ + ## ๐Ÿ› ๏ธ ์•„ํ‚คํ…์ฒ˜ Untitled @@ -30,6 +42,9 @@ ์ „์ฒด ๊ตฌ์กฐ๋Š” UI Layer๊ณผ Data Layer, ๋‘ ๋ถ€๋ถ„์œผ๋กœ ์ด๋ฃจ์–ด์ ธ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ฐ ๊ณ„์ธต์€ ์ž์‹ ๋งŒ์˜ ์š”์†Œ๋“ค์„ ๊ฐ€์ง€๊ณ  ํŠน์ • ์—ญํ• ์„ ํ•ฉ๋‹ˆ๋‹ค. ํ™”์‚ดํ‘œ๋Š” ํ•œ ์š”์†Œ๊ฐ€ ๋‹ค๋ฅธ ์š”์†Œ์— ์˜์กดํ•œ๋‹ค๋Š” ๊ฒƒ์„ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค. + +
+ ### **๐Ÿ“Œ ์•„ํ‚คํ…์ฒ˜ ๊ฐœ์š”** Untitled @@ -44,6 +59,8 @@ image +
+
## ๐Ÿชง ๋ชจ๋“ˆํ™” @@ -57,6 +74,11 @@ - **feature:Module** - ํŠน์ • ๊ธฐ๋Šฅ์„ ๋‹ด๋‹นํ•˜๋Š” ๋ชจ๋“ˆ์ž…๋‹ˆ๋‹ค. ํ•„์š”ํ•  ๋•Œ ๋‹ค์–‘ํ•œ ์•ฑ์—์„œ ์žฌ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•˜๋ฉฐ, ๋…๋ฆฝ์ ์œผ๋กœ ์œ ์ง€๋ฉ๋‹ˆ๋‹ค. ํ•œ ํด๋ž˜์Šค๊ฐ€ ํŠน์ • `feature` ๋ชจ๋“ˆ์—๋งŒ ํ•„์š”ํ•˜๋ฉด ๊ทธ ์•ˆ์— ๋‘ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์œผ๋ฉด `core` ๋ชจ๋“ˆ๋กœ ์˜ฎ๊ฒจ์•ผ ํ•ฉ๋‹ˆ๋‹ค. `feature` ๋ชจ๋“ˆ์€ ๋‹ค๋ฅธ `feature` ๋ชจ๋“ˆ์— ์˜์กดํ•˜๋ฉด ์•ˆ ๋˜๋ฉฐ, `core` ๋ชจ๋“ˆ์—๋งŒ ์˜์กดํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. - **core:Module** - ์•ฑ ๋‚ด์—์„œ ๊ณตํ†ต์ ์œผ๋กœ ์‚ฌ์šฉ๋˜๋Š” ๋ถ€๋ถ„๋“ค์„ ๋‹ด์€ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ๋ชจ๋“ˆ์ž…๋‹ˆ๋‹ค. ๋‹ค๋ฅธ `core` ๋ชจ๋“ˆ์—๋Š” ์˜์กดํ•  ์ˆ˜ ์žˆ์ง€๋งŒ, `feature`์ด๋‚˜ `app` ๋ชจ๋“ˆ์—๋Š” ์˜์กดํ•˜๋ฉด ์•ˆ ๋ฉ๋‹ˆ๋‹ค. + + +
+
+ ## ๐Ÿงช Testing **Mineme**๋Š” `Hilt`๋ฅผ ์‚ฌ์šฉํ•œ DI๋กœ testing์„ ์‰ฝ๊ฒŒ ํ•ฉ๋‹ˆ๋‹ค. @@ -69,6 +91,12 @@ - Instrumentation tests์—์„œ, ์‚ฌ์šฉ์ž์˜ preferences๋ฅผ ์ž„์‹œ ํด๋”์— ์ €์žฅํ•œ ํ›„, ํ…Œ์ŠคํŠธ๊ฐ€ ๋๋‚˜๋ฉด ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. ์ด๋ ‡๊ฒŒ ํ•จ์œผ๋กœ์จ real DataStore์˜ ๋™์ž‘์„ ๋ชจ๋‘ ํ…Œ์ŠคํŠธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - Test versions์˜ repositories๋Š” standard repositories์™€ ๊ฐ™์€ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋ฉฐ, ์ถ”๊ฐ€์ ์ธ testing hooks๋„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ์ด๋ฅผ ํ†ตํ•ด ViewModel์˜ behavior๋ฅผ ๊ฒ€์ฆํ•ฉ๋‹ˆ๋‹ค. + + +
+
+ + ## ๐Ÿ–ฅ๏ธ UI **Mineme**๋Š” [Material 3 ๊ฐ€์ด๋“œ๋ผ์ธ](https://m3.material.io/)์„ ์‚ฌ์šฉํ•˜์—ฌ ๋””์ž์ธ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. @@ -78,6 +106,10 @@ - **๋™์  ์ƒ‰์ƒ** - ์‚ฌ์šฉ์ž์˜ ํ˜„์žฌ ์ƒ‰์ƒ ํ…Œ๋งˆ๋ฅผ ๊ธฐ๋ฐ˜ - **๊ธฐ๋ณธ ํ…Œ๋งˆ** - ๋™์  ์ƒ‰์ƒ์„ ์ง€์›ํ•˜์ง€ ์•Š์„ ๋•Œ + +
+
+ ## ยฉ๏ธ License ``` @@ -96,4 +128,8 @@ limitations under the License. ``` + +
+
+ ## ๐Ÿ“š ๊ฐœ๋ฐœ๋กœ๊ทธ