Skip to content

Commit

Permalink
[docs] #19 README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cacaocoffee authored Sep 6, 2024
1 parent 10bad21 commit 7c8edce
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<table>
<tr>
<td><img width="500" alt="img_memozi_banner1" src="https://github.com/user-attachments/assets/a8e1c88b-c500-4767-b221-d6299475e1eb"></td>
<td><img width="500" alt="img_memozi_banner2" src="https://github.com/user-attachments/assets/d7a83064-36b7-4ab8-8306-4a8c927b1462"></td>
</tr>
</table>


## πŸ”’ λͺ©μ°¨
[ν”„λ‘œμ νŠΈ μ„€λͺ…](#ν”„λ‘œμ νŠΈ-μ„€λͺ…)</br>
[μ£Όμš” κΈ°λŠ₯](#μ£Όμš”-κΈ°λŠ₯)</br>
[기술 및 아킀텍쳐 μ„ μ •](#기술-및-아킀텍쳐-μ„ μ •)</br>
[μ»¨λ²€μ…˜ κ·œμΉ™ 및 브랜치 μ „λž΅](#μ»¨λ²€μ…˜-κ·œμΉ™-및-브랜치-μ „λž΅)</br>
[νŒ€μ›λ³„ μ—­ν•  λΆ„λ‹΄](#νŒ€μ›λ³„-μ—­ν• -λΆ„λ‹΄)</br>
[폴더링](#폴더링)</br>

## πŸ…ΏοΈ ν”„λ‘œμ νŠΈ μ„€λͺ…
** λ©”λͺ¨μ§€λŠ” 일상 속에 λ©”λͺ¨μ™€ 사진과 ν•¨κ»˜ μ“°λŠ” 일기λ₯Ό 적을 수 μžˆλŠ” λ©”λͺ¨ μ•± μ„œλΉ„μŠ€ μž…λ‹ˆλ‹€. **

## βš™οΈ 기술 및 아킀텍쳐 μ„ μ •
+ `IDE - Android Studio koala`</br>
+ `Architecture - MVI, Clean Architecture`</br>
+ `DI - Hilt`</br>
+ `Network - Retrofit`</br>
+ `Asynchronous - Coroutine, Flow`</br>
+ `Jetpack - DataStore, Navigation, `</br>
+ `CI - Github Actions`</br>
+ `Image - coil`</br>
+ `lint - ktlint`</br>
+ `third party - amazon aws, kakao login `</br></br>

## πŸ“ μ£Όμš” κΈ°λŠ₯
1. λ©”λͺ¨ κΈ°λŠ₯: κΈ€κ³Ό μ²΄ν¬λ°•μŠ€λ₯Ό 톡해 λ©”λͺ¨λ₯Ό μž‘μ„± μˆ˜μ •ν•˜λŠ” κΈ°λŠ₯
2. μΉ΄ν…Œκ³ λ¦¬ κΈ°λŠ₯: μΉ΄ν…Œκ³ λ¦¬ λ³„λ‘œ λ©”λͺ¨λ₯Ό μ €μž₯ν•˜κ³  묢을 수 μžˆλŠ” κΈ°λŠ₯
3. 일기 κΈ°λŠ₯: 사진과 ν•¨κ»˜ ν…μŠ€νŠΈλ‘œ ν•˜λ£¨ν•˜λ£¨ 일기λ₯Ό μž‘μ„±ν•˜λŠ” κΈ°λŠ₯
4. μ•Œλ¦Ό κΈ°λŠ₯: νŠΉμ • μ‹œκ°„λ³„λ‘œ 일기λ₯Ό 쓰도둝 μ•Œλ¦Όμ„ λ³΄λ‚΄λŠ” κΈ°λŠ₯
5. 검색 κΈ°λŠ₯: νŠΉμ • ν‚€μ›Œλ“œλ‘œ κ²€μƒ‰ν•˜λŠ” κΈ°λŠ₯

## πŸ‘€ νŒ€μ›λ³„ μ—­ν•  λΆ„λ‹΄
|<img src="https://avatars.githubusercontent.com/u/75840431?v=4" width="170" />|<img src="https://avatars.githubusercontent.com/u/137873124?v=4" width="170" />|<img src="https://avatars.githubusercontent.com/u/137160756?v=4" width="170"/>|<img src="https://avatars.githubusercontent.com/u/86788873?v=4" width="170" />|
|:---------:|:---------:|:---------:|:---------:|
|[πŸ‘‘κΉ€λͺ…석](https://github.com/cacaocoffee)|[μ£Όνš¨μ€](https://github.com/hyoeunjoo)|[μ†λ―Όμž¬](https://github.com/SYAAINN)|[κΉ€λ―Όμš°](https://github.com/DoReMinWoo)|
| `λ©”λͺ¨ν™”λ©΄, λ©”λͺ¨ μΉ΄ν…Œκ³ λ¦¬ μΆ”κ°€, κΈ°μ΄ˆμ„ΈνŒ…` | `λ©”λͺ¨ 검색, λ©”λͺ¨ 상세화면` | `일기 ν™”λ©΄(λ¦¬μŠ€νŠΈν˜•/μΊ˜λ¦°λ”ν˜•)` | `둜그인 UI, μ˜¨λ³΄λ”©, μ„€μ •` | </br>


## ❗ μ»¨λ²€μ…˜ κ·œμΉ™ 및 브랜치 μ „λž΅

**κΉƒ μ»¨λ²€μ…˜:** [Git Convention](https://www.notion.so/Branch-Strategy-2b1a261ec26b4f88a915701024a019be?pvs=4) </br>
**μ½”λ“œ μ»¨λ²€μ…˜:** [Code Convention](https://www.notion.so/Git-Convention-d9d669bcc4b448ffa3240c31b0f352d8?pvs=4) </br>
**브랜치 μ „λž΅:** [Branch Strategy](https://www.notion.so/Code-Convention-fb683fa7b3104b23907b07fd7499d521?pvs=4) </br></br>

## πŸ—‚οΈ 폴더링

```bash
β”œβ”€β”€ Memozi
β”œβ”€β”€ πŸ“:app
β”œβ”€β”€ πŸ“:build-logic
β”‚ β”œβ”€β”€ πŸ“ convention
β”œβ”€β”€ πŸ“:core
β”‚ β”œβ”€β”€ πŸ—‚οΈ buildconfig
β”œβ”€β”€ πŸ“:data
β”‚ β”œβ”€β”€ πŸ—‚οΈ auth
β”‚ β”œβ”€β”€ πŸ—‚οΈ oauth
β”œβ”€β”€ πŸ“:local
β”‚ β”œβ”€β”€ πŸ—‚οΈ auth
β”œβ”€β”€ πŸ“:remote
β”‚ β”œβ”€β”€ πŸ—‚οΈ auth
β”œβ”€β”€ πŸ“:domain
β”‚ β”œβ”€β”€ πŸ—‚οΈ auth
β”‚ β”œβ”€β”€ πŸ—‚οΈ oauth
β”œβ”€β”€ πŸ“:feature
β”‚ β”œβ”€β”€ πŸ—‚οΈ navigator
β”‚ β”œβ”€β”€ πŸ—‚οΈ login
β”‚ β”œβ”€β”€ πŸ—‚οΈ memo
β”‚ β”œβ”€β”€ πŸ—‚οΈ diary
β”œβ”€β”€ πŸ“:gradle
β”‚ β”œβ”€β”€ libs.versions.toml
```

0 comments on commit 7c8edce

Please sign in to comment.