Skip to content

Commit

Permalink
Merge pull request #275 from mash-up-kr/document/#274-readme
Browse files Browse the repository at this point in the history
[#274] ๋ฆฌ๋“œ๋ฏธ ์ถ”๊ฐ€
  • Loading branch information
SEO-J17 authored Aug 29, 2024
2 parents 07cd5fc + 754c2c2 commit dff02d8
Showing 1 changed file with 98 additions and 4 deletions.
102 changes: 98 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,99 @@
# gabbangzip-Android
๊ฐ€์ž๋นต์ง‘์œผ๋กœ Android Repository
# ๐Ÿ“ธ PIC

### Shortcuts
- [Code Convention](https://github.com/mash-up-kr/gabbangzip-Android/wiki/Code-Convention)
<img src="https://github.com/user-attachments/assets/b8330514-e473-4087-b724-d3b67641426e"/>

**๊ทธ๋‚ ์˜ ์ถ”์–ต์„ ๊ธฐ๋กํ•˜๋Š” ์šฐ๋ฆฌ๋งŒ์˜ ๋„ค์ปท์‚ฌ์ง„**

- ์›ํ•˜๋Š” ์นœ๊ตฌ๋“ค๊ณผ ๊ทธ๋ฃน๋ฐฉ์„ ๋งŒ๋“ค์–ด์š”
- ํ•จ๊ป˜ ์ฐ์€ ์‚ฌ์ง„๋“ค์„ ํˆฌํ‘œํ•ด์š”
- ๋ฒ ์ŠคํŠธ ์‚ฌ์ง„์œผ๋กœ ๋„ค์ปท ์‚ฌ์ง„์ด ๋งŒ๋“ค์–ด์ ธ์š”

# ๐Ÿ’พ App Download

<a href="https://play.google.com/store/apps/details?id=com.mashup.gabbangzip.sharedalbum">
<img src="https://user-images.githubusercontent.com/63157395/211233100-2f255c00-3336-4125-b5da-2fd935e40b5a.png" width="101px" />
</a>

# ๐Ÿ’ป Contributor

<div align="center">
<table style="font-weight : bold">
<tr>
<td align="center">
<a href="https://github.com/sooziini">
<img alt="sooziini" src="https://avatars.githubusercontent.com/sooziini " width="100" />
</a>
</td>
<td align="center">
<a href="https://github.com/SEO-J17">
<img alt="SEO-J17" src="https://avatars.githubusercontent.com/SEO-J17" width="100" />
</a>
</td>
<td align="center">
<a href="https://github.com/oreocube">
<img alt="oreocube" src="https://avatars.githubusercontent.com/oreocube" width="100" />
</a>
</td>
<td align="center">
<a href="https://github.com/JeonK1">
<img alt="JeonK1" src="https://avatars.githubusercontent.com/JeonK1" width="100" />
</a>
</td>
</tr>
<tr>
<td align="center">๋ฐ•์ˆ˜์ง„</td>
<td align="center">์„œ์ •์šฐ</td>
<td align="center">์ฃผ์ง€ํ˜œ</td>
<td align="center">์ „๊ณ„์›</td>
</tr>
</table>
</div>

# ๐ŸŽจ Structure

<img src=https://github.com/user-attachments/assets/2678bf88-461d-436a-abb8-f3406313db45/>

+ Claen Architecture์™€ MVVM ํŒจํ„ด์„ ์ ์šฉํ•˜์—ฌ ํ”„๋กœ์ ํŠธ๋ฅผ ๊ตฌ์„ฑํ–ˆ์Šต๋‹ˆ๋‹ค
+ ๊ฐ€์ด๋“œ์— ๋”ฐ๋ผ App, Data, Domain, Presentation ๋ชจ๋“ˆ๋กœ ๋ถ„๋ฆฌํ•˜๊ณ  ๋‹ค์Œ ๊ทธ๋ฆผ๊ณผ ๊ฐ™์€ ์˜์กด์„ฑ์„ ๊ฐ€์ง€๋„๋ก ์„ค๊ณ„ํ–ˆ์Šต๋‹ˆ๋‹ค.

# ๐Ÿ›  Tech & Library

+ Target SDK Level 34
+ Min SDK Level 26
+ Kotlin 1.9.10

| ๊ตฌ๋ถ„ | ๋‚ด์šฉ |
|-------------------------|-----------------------------------------------------------------------|
| Architecture | Clean Architecture |
| DesignPattern | MVVM |
| Jetpack | Compose, Lifecycle, Navigation, EncryptedSharedPreferences, ViewModel |
| Network | Retrofit, OkHttp, Moshi |
| Asynchronous Processing | Coroutine, Flow |
| Dependency Injection | Hilt |
| Third Party Library | Coil-Compose, Kakao SDK, Firebase Cloud Messaging |
| Other Tool | Figma |

# โœจ Features

<div>
<img
width="23%"
alt="image"
src="https://github.com/user-attachments/assets/344b519d-af89-4ea5-9a0d-890aeab7114e"
/>
<img
width="23%"
alt="image"
src="https://github.com/user-attachments/assets/e1d161ad-1e12-487e-afe8-3061f2f46ec8"
/>
<img
width="23%"
alt="image"
src="https://github.com/user-attachments/assets/80bdc49e-8b49-4432-b59e-4ae5fb83a04a"
/>
<img
width="23%"
alt="image"
src="https://github.com/user-attachments/assets/f0c99971-3a71-473d-820e-1dbd9df5cac3"
/>
</div>

0 comments on commit dff02d8

Please sign in to comment.