Merge pull request #45 from NOW-SOPT-APP4-KREAM/docs-readme

README.md

@@ -2,16 +2,59 @@
 > NOW SOPT 34th 합동 세미나 앱 4조 Android팀 <br>
 24.05.11 - 24.05.24
 
+![KREAM](https://github.com/NOW-SOPT-APP4-KREAM/KREAM-Android/assets/103172971/d3d9b1c3-81ef-47ef-8a73-bcbbc48b13e9)
 
 ## 🍨 *****Contributors*****
 | 배지현 <br> [@jihyunniiii](https://github.com/jihyunniiii) |             박효빈 <br> [@Hyobeen-Park](https://github.com/Hyobeen-Park)             |              신민석 <br>[@t1nm1ksun](https://github.com/t1nm1ksun)               |
 |:---:|:-----------------------------------------------------------------------------:|:-----------------------------------------------------------------------------:|
 | <img width="250" src="https://avatars.githubusercontent.com/u/103172971?v=4"/> | <img width="250" src="https://avatars.githubusercontent.com/u/98209004?v=4"/> | <img width="250" src="https://avatars.githubusercontent.com/u/122257945?v=4"/> |
+| `View3 (검색 페이지)`,`View4 (상품 상세 페이지)` |`View1 (발매정보 페이지)`|`View2 (추천 페이지)`|
 
 
 ## 📗 *****Convention*****
 [📕 Git Convention & Branch Strategy](https://jihyunniiii.notion.site/Git-Convention-Branch-Strategy-a524c11f5ea44c74b41177becd945102?pvs=4)
 <br>
 [📘 Android Coding Convention](https://jihyunniiii.notion.site/Android-Coding-Convention-027eef4f49d8434da8e4783b5ff7ce10?pvs=4)
 <br>
-[📒 Package Convention](https://jihyunniiii.notion.site/Package-Convention-9f1c20d264b840e6850c48a618dc8b42?pvs=4)
+[📒 Package Convention](https://jihyunniiii.notion.site/Package-Convention-9f1c20d264b840e6850c48a618dc8b42?pvs=4)
+
+## 📷 *****ScreenShot*****
+
+https://github.com/NOW-SOPT-APP4-KREAM/KREAM-Android/assets/103172971/34d07a0b-2b58-48d2-98ad-c31c63b310a3
+
+
+## 📁 *****Foldering*****
+
+```
+📂 org.sopt.kream
+┣ 📂 data
+┃ ┣ 📂 datasource
+┃ ┣ 📂 datasourceimpl
+┃ ┣ 📂 mapper
+┃ ┣ 📂 model
+┃ ┃ ┣ 📂 request
+┃ ┃ ┣ 📂 response
+┃ ┣ 📂 repository
+┃ ┣ 📂 service
+┣ 📂 domain
+┃ ┣ 📂 model
+┃ ┣ 📂 repository
+┣ 📂 presentation
+┃ ┣ 📂 common
+┃ ┣ 📂 model
+┃ ┣ 📂 type
+┃ ┣ 📂 ui
+┃ ┃ ┣ 📂 main
+┃ ┃ ┣ 📂 productdetail
+┃ ┃ ┣ 📂 search
+┣ 📂 theme
+┣ 📂 util
+┃ ┣ 📂 base
+┃ ┣ 📂 component
+┃ ┣ 📂 context
+┃ ┣ 📂 fragment
+┃ ┣ 📂 int
+┃ ┣ 📂 intent
+┃ ┣ 📂 modifier
+┃ ┣ 📂 modifier
+```

app/src/main/java/org/sopt/kream/data/ApiFactory.kt

@@ -6,7 +6,6 @@ import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.OkHttpClient
 import okhttp3.logging.HttpLoggingInterceptor
 import org.sopt.kream.BuildConfig
-import org.sopt.kream.data.service.DummyService
 import org.sopt.kream.data.service.ProductService
 import retrofit2.Retrofit
 
@@ -30,6 +29,5 @@ object ApiFactory {
 }
 
 object ServicePool {
-    val dummyService = ApiFactory.create<DummyService>()
     val productService = ApiFactory.create<ProductService>()
 }

app/src/main/java/org/sopt/kream/presentation/common/ViewModelFactory.kt

@@ -2,21 +2,16 @@ package org.sopt.kream.presentation.common
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import org.sopt.kream.data.datasourceimpl.DummyRemoteDataSourceImpl
 import org.sopt.kream.data.datasourceimpl.ProductRemoteDataSourceImpl
-import org.sopt.kream.data.repository.DummyRepositoryImpl
 import org.sopt.kream.data.repository.ProductRepositoryImpl
-import org.sopt.kream.presentation.ui.dummy.DummyViewModel
 import org.sopt.kream.presentation.ui.main.home.recommend.RecommendViewModel
 import org.sopt.kream.presentation.ui.main.home.release.ReleaseProductViewModel
 import org.sopt.kream.presentation.ui.productdetail.ProductDetailViewModel
 import org.sopt.kream.presentation.ui.search.SearchViewModel
 
 class ViewModelFactory : ViewModelProvider.Factory {
     override fun <T : ViewModel> create(modelClass: Class<T>): T {
-        if (modelClass.isAssignableFrom(DummyViewModel::class.java)) {
-            return DummyViewModel(DummyRepositoryImpl(DummyRemoteDataSourceImpl())) as T
-        } else if (modelClass.isAssignableFrom(SearchViewModel::class.java)) {
+        if (modelClass.isAssignableFrom(SearchViewModel::class.java)) {
             return SearchViewModel(ProductRepositoryImpl(ProductRemoteDataSourceImpl())) as T
         } else if (modelClass.isAssignableFrom(ReleaseProductViewModel::class.java)) {
             return ReleaseProductViewModel(ProductRepositoryImpl(ProductRemoteDataSourceImpl())) as T

app/src/main/java/org/sopt/kream/presentation/ui/model/Advertisement.kt → app/src/main/java/org/sopt/kream/presentation/model/Advertisement.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.model
+package org.sopt.kream.presentation.model
 
 data class Advertisement(
     val id: Int,

app/src/main/java/org/sopt/kream/presentation/ui/model/ProductDetailInfo.kt → app/src/main/java/org/sopt/kream/presentation/model/ProductDetailInfo.kt

@@ -1,6 +1,6 @@
-package org.sopt.kream.presentation.ui.model
+package org.sopt.kream.presentation.model
 
-import org.sopt.kream.presentation.ui.type.ProductDetailInfoType
+import org.sopt.kream.presentation.type.ProductDetailInfoType
 
 data class ProductDetailInfo(
     val productDetailInfoType: ProductDetailInfoType,

app/src/main/java/org/sopt/kream/presentation/ui/type/AdvertisementType.kt → app/src/main/java/org/sopt/kream/presentation/type/AdvertisementType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import org.sopt.kream.R
 

app/src/main/java/org/sopt/kream/presentation/ui/type/HomeTabBarType.kt → app/src/main/java/org/sopt/kream/presentation/type/HomeTabBarType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import androidx.annotation.StringRes
 import org.sopt.kream.R

app/src/main/java/org/sopt/kream/presentation/ui/type/ProductDetailButtonType.kt → app/src/main/java/org/sopt/kream/presentation/type/ProductDetailButtonType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import androidx.annotation.ColorRes
 import androidx.annotation.StringRes

app/src/main/java/org/sopt/kream/presentation/ui/type/ProductDetailInfoType.kt → app/src/main/java/org/sopt/kream/presentation/type/ProductDetailInfoType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import androidx.annotation.StringRes
 import org.sopt.kream.R

app/src/main/java/org/sopt/kream/presentation/ui/type/RecommendAdvertisementType.kt → app/src/main/java/org/sopt/kream/presentation/type/RecommendAdvertisementType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import org.sopt.kream.R
 

app/src/main/java/org/sopt/kream/presentation/ui/type/RecommendCircleMenuType.kt → app/src/main/java/org/sopt/kream/presentation/type/RecommendCircleMenuType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import androidx.annotation.DrawableRes
 import org.sopt.kream.R
@@ -8,43 +8,43 @@ enum class RecommendCircleMenuType(
     val menu: Int,
 ) {
     KREAM_CARD(
-        image = R.drawable.view2_img_cricle_01,
+        image = R.drawable.img_view2_cricle_01,
         menu = R.string.type_circle_menu_kream_card,
     ),
     CREAM_DRAW(
-        image = R.drawable.view2_img_cricle_02,
+        image = R.drawable.img_view2_cricle_02,
         menu = R.string.type_circle_menu_kream_draw,
     ),
     MAN_RECOMMEND(
-        image = R.drawable.view2_img_cricle_03,
+        image = R.drawable.img_view2_cricle_03,
         menu = R.string.type_circle_menu_man_recommend,
     ),
     WOMAN_RECOMMEND(
-        image = R.drawable.view2_img_cricle_04,
+        image = R.drawable.img_view2_cricle_04,
         menu = R.string.type_circle_menu_woman_recommend,
     ),
     NEW_RECOMMEND(
-        image = R.drawable.view2_img_cricle_05,
+        image = R.drawable.img_view2_cricle_05,
         menu = R.string.type_circle_menu_new_recommend,
     ),
     UNDER_PRICE(
-        image = R.drawable.view2_img_cricle_06,
+        image = R.drawable.img_view2_cricle_06,
         menu = R.string.type_circle_menu_under_price,
     ),
     SPRING_SALE(
-        image = R.drawable.view2_img_cricle_07,
+        image = R.drawable.img_view2_cricle_07,
         menu = R.string.type_circle_menu_spring_sale,
     ),
     CHANEL(
-        image = R.drawable.view2_img_cricle_08,
+        image = R.drawable.img_view2_cricle_08,
         menu = R.string.type_circle_menu_chanel,
     ),
     MAY(
-        image = R.drawable.view2_img_cricle_09,
+        image = R.drawable.img_view2_cricle_09,
         menu = R.string.type_circle_menu_may,
     ),
     SONY_SUPREME(
-        image = R.drawable.view2_img_cricle_10,
+        image = R.drawable.img_view2_cricle_10,
         menu = R.string.type_circle_menu_sony_supreme,
     ),
 }

app/src/main/java/org/sopt/kream/presentation/ui/type/SearchTabBarType.kt → app/src/main/java/org/sopt/kream/presentation/type/SearchTabBarType.kt

@@ -1,4 +1,4 @@
-package org.sopt.kream.presentation.ui.type
+package org.sopt.kream.presentation.type
 
 import androidx.annotation.StringRes
 import org.sopt.kream.R

app/src/main/java/org/sopt/kream/presentation/ui/main/home/HomeFragment.kt

@@ -23,9 +23,9 @@ import androidx.fragment.app.Fragment
 import androidx.navigation.fragment.findNavController
 import org.sopt.kream.R
 import org.sopt.kream.databinding.FragmentHomeBinding
+import org.sopt.kream.presentation.type.HomeTabBarType
 import org.sopt.kream.presentation.ui.main.home.recommend.RecommendFragment
 import org.sopt.kream.presentation.ui.main.home.release.ReleaseFragment
-import org.sopt.kream.presentation.ui.type.HomeTabBarType
 import org.sopt.kream.theme.PinkColor
 import org.sopt.kream.util.base.BindingFragment
 import org.sopt.kream.util.component.KreamTab

app/src/main/java/org/sopt/kream/presentation/ui/main/home/recommend/RecommendCircleMenuAdapter.kt

@@ -4,7 +4,7 @@ import android.view.LayoutInflater
 import android.view.ViewGroup
 import androidx.recyclerview.widget.ListAdapter
 import org.sopt.kream.databinding.ItemRecommendCircleMenuBinding
-import org.sopt.kream.presentation.ui.type.RecommendCircleMenuType
+import org.sopt.kream.presentation.type.RecommendCircleMenuType
 import org.sopt.kream.util.view.ItemDiffCallback
 
 class RecommendCircleMenuAdapter() : ListAdapter<RecommendCircleMenuType, RecommendCircleMenuViewHolder>(

app/src/main/java/org/sopt/kream/presentation/ui/main/home/recommend/RecommendCircleMenuViewHolder.kt

@@ -2,7 +2,7 @@ package org.sopt.kream.presentation.ui.main.home.recommend
 
 import androidx.recyclerview.widget.RecyclerView
 import org.sopt.kream.databinding.ItemRecommendCircleMenuBinding
-import org.sopt.kream.presentation.ui.type.RecommendCircleMenuType
+import org.sopt.kream.presentation.type.RecommendCircleMenuType
 
 class RecommendCircleMenuViewHolder(
     private val binding: ItemRecommendCircleMenuBinding,