Skip to content

Commit

Permalink
Merge pull request #173 from TeamPINGLE/docs-readme
Browse files Browse the repository at this point in the history
[docs] update README.md
  • Loading branch information
jihyunniiii authored Jan 19, 2024
2 parents 9fe148f + 8665745 commit 7b117fe
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 7 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 🌀 PINGLE-ANDROID 🌀

<img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/0ce1b422-8d65-44e5-b2e6-d5cfc1becf2a"/>

## ➰ *****PINGLE*****
Ready to PINGLE? <br>
가볍고 재미있는 모임 문화, 핑글과 함께 만들어요!
Expand All @@ -13,8 +15,34 @@ Ready to PINGLE? <br>
## 👋 *****Contributors*****
| 배지현 <br> [@jihyunniiii](https://github.com/jihyunniiii) | 김민우 <br> [@DoReMinWoo](https://github.com/DoReMinWoo) | 하지은 <br>[@HAJIEUN02](https://github.com/HAJIEUN02) | 이다은 <br>[@Dan2dani](https://github.com/Dan2dani) |
|:---:| :---: | :---: | :---: |
| <img width="250" src="https://avatars.githubusercontent.com/u/103172971?v=4"/> |<img width="250" src="https://avatars.githubusercontent.com/u/86788873?v=4"/>|<img width="250" src="https://avatars.githubusercontent.com/u/83916472?v=4"/>|<img width="250" src="https://avatars.githubusercontent.com/u/77060011?v=4"/>|
| `메인 지도뷰` |`온보딩/회원가입`|`핑글 개최 프로세스`|`핑글 개최 프로세스`, `설정`|
| <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/e6165367-371d-4704-9217-6da6bef0aaef"/> |<img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/42e562fa-b41f-4267-b37a-af0c5bf34f01"/>|<img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/afdb42f1-33ba-417b-ab96-398c2650bd95"/>|<img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/83430ee5-a5b9-4679-b1f5-67a56be7996e"/>|
| `메인 지도뷰` | `온보딩/회원가입`, `마이핑글` | `핑글 개최 프로세스`, `참여자` | `핑글 개최 프로세스`, `더보기` |

<br>

## 📷 *****ScreenShot*****
| <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/837a5b61-3593-4f88-a07b-ae92a794a268"/> | <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/422a7dc3-f06f-4c90-a4a8-bd9f8d28dc87"/> | <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/26b568e4-64e5-4e02-aa46-453446309c4c"/> |
| :---: | :---: | :---: |
|`온보딩/회원가입`|`메인 지도 뷰 - 칩 필터링`|`메인 지도 뷰 - 카드`|
| <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/912f9aea-e6cc-4278-aec9-70a1fd5a33bb"/> | <img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/7c2e247c-9ff8-48d2-8844-226185ea89ff"/> |<img width="250" src="https://github.com/TeamPINGLE/PINGLE-ANDROID/assets/103172971/edd79de8-a274-408b-b188-36e6fc288ada">
|`핑글 개최 프로세스`|`마이핑글`|`더보기`|

<br>

## 👩🏻‍💻 ***𝙏𝙚𝙘𝙝 𝙎𝙩𝙖𝙘𝙠***

| Title | Content |
| --- | --- |
| Architecture | Clean Architecture, MVVM |
| Design Pattern | Repository Pattern, Adapter Pattern, Delegation Pattern, Observer Pattern |
| Jetpack Components | encryptedsharedpreferences, LiveData, Lifecycle, ViewModel, DataBinding |
| Dependency Injection | Hilt |
| Network | Retrofit, OkHttp |
| Asynchronous Processing | Coroutine(+ Flow) |
| Third Party Library | Coil, Firebase, Timber, kotlinSerialization, sentry, naverMap, playServiceLocation, progressBar |
| Strategy | Git Flow |
| CI | GitHub Action(KtLint, Complie Check) |
| Other Tool | Slack, Notion, Figma, Postman |

<br>

Expand All @@ -35,10 +63,11 @@ Ready to PINGLE? <br>
┃ ┣ 📂 usecase
┣ 📂 presentation
┃ ┣ 📂 mapper
┃ ┣ 📂 mode
┃ ┣ 📂 model
┃ ┣ 📂 type
┃ ┣ 📂 ui
┣ 📂 util
┃ ┣ 📂 activity
┃ ┣ 📂 base
┃ ┣ 📂 component
┃ ┣ 📂 context
Expand Down
2 changes: 1 addition & 1 deletion app/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ android {
applicationId = "org.sopt.pingle"
minSdk = 28
targetSdk = 34
versionCode = 14
versionCode = 15
versionName = "1.1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
Expand Down
6 changes: 3 additions & 3 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ appcompat = "1.6.1"
constraintlayout = "2.1.4"
activity = "1.8.2"
fragment = "1.6.2"
lifecycle = "2.6.2"
lifecycle = "2.7.0"
security = "1.1.0-alpha06"
splash = "1.0.0"
splash = "1.0.1"

# Google
material = "1.11.0"
google-services = "4.4.0"
firebase-crashlytics = "2.9.9"
firebase-bom = "32.7.0"
firebase-bom = "32.7.1"

# Test
junit = "4.13.2"
Expand Down

0 comments on commit 7b117fe

Please sign in to comment.