diff --git a/README.md b/README.md index 77a68d49..e3c6237d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ # hankki-server # πŸ‘‹ ABOUT HANKKI -<λ‘œκ³ λ“€μ–΄κ°ˆμ˜ˆμ •>
-**`WHAT ?`** λŒ€ν•™κ΅λ₯Ό μ€‘μ‹¬μœΌλ‘œ **8000원 μ΄ν•˜μ˜ 메뉴λ₯Ό 가진 식당**을 μ œκ³΅ν•˜λŠ” ν”„λ‘œλ•νŠΈ + +
+ +
+ +**`WHAT?`** λŒ€ν•™κ΅λ₯Ό μ€‘μ‹¬μœΌλ‘œ **8000원 μ΄ν•˜μ˜ 메뉴λ₯Ό 가진 식당**을 μ œκ³΅ν•˜λŠ” ν”„λ‘œλ•νŠΈ **`HOW?`** μ„œμšΈ λ‚΄μ˜ λŒ€ν•™ 묢음 9-10개λ₯Ό μ€‘μ‹¬μœΌλ‘œ 50κ°œμ”© μ•½ 500개의 식당을 λͺ¨μ•„ λ¦΄λ¦¬μ¦ˆν•˜κ³ , μΆ”ν›„ **μœ μ €μ°Έμ—¬ν˜•**으둜 μš΄μ˜ν•  κ³„νš **`WHY?`** μΉ˜μ†ŸλŠ” 물가에 λ°₯ ν•œλΌ 먹기도 λΆ€λ‹΄λ˜λŠ” μš”μ¦˜, μ €λ ΄ν•œ 식당을 κ³΅μœ ν•˜λ©° **ν•¨κ»˜** **잘 λ¨Ήκ³  잘 μ‚΄κΈ° μœ„ν•΄μ„œ!** +
+ # βš’οΈStack
+

# πŸ“ERD ![hankki](https://github.com/Team-Hankki/hankki-server/assets/109809242/36c645b6-68e6-42b8-a9e2-9ddf790a6f4f) +

# πŸ“œ Covention ## Code Convetion | ν•­λͺ© | κ·œμΉ™ | @@ -40,7 +48,7 @@ | `docs` | λ¬Έμ„œ μˆ˜μ • | | `infra` | 인프라 κ΄€λ ¨ μž‘μ—… | | `hotfix` | 운영 μ„œλ²„ ν•«ν”½μŠ€ μž‘μ—… | -|'dependency' | μ˜μ‘΄μ„±(μ•„λ§ˆ μ˜μ‘΄μ„±λ§Œ μΆ”κ°€ν•˜λŠ” μž‘μ—…μ„ 없을 κ²ƒμœΌλ‘œ μ˜ˆμƒλ˜μ–΄ μ“Έ 일은 없을듯)| +| `dependency ` | μ˜μ‘΄μ„± | ### Branch Naming `/` @@ -59,6 +67,8 @@ close # ## To Reviewers ``` +
+ ### Review | PN| what| |------|-----| @@ -68,10 +78,44 @@ close # | P4 | λ°˜μ˜ν•΄λ„ μ’‹κ³  λ„˜μ–΄κ°€λ„ μ’‹μŠ΅λ‹ˆλ‹€ (Approve) | |P5 | κ·Έλƒ₯ μ‚¬μ†Œν•œ μ˜κ²¬μž…λ‹ˆλ‹€ (Approve) | +

+# πŸ—‚οΈ Package +``` +β”œβ”€β”€ πŸ—‚οΈ Dockerfile-dev +β”œβ”€β”€ πŸ—‚οΈ server-yml +└── πŸ—‚οΈ org.hankki.hankkiserver +β”‚Β Β  └── πŸ—‚οΈ hankkiserver +β”‚Β Β  β”œβ”€β”€ πŸ’½ HankkiserverApplication +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ—‚οΈ api +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ DomainA +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ controller +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── request +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── service +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── response +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── commmand +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ—‚οΈ auth +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ config +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ filter +β”‚Β Β  β”‚Β Β  β”‚Β Β  └── πŸ“‚ jwt +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ—‚οΈ common +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ—‚οΈ domain +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ common +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ config +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ DomainA +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ model +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── repository +β”‚Β Β  β”‚Β Β  └── πŸ—‚οΈ external +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ πŸ“‚ config +β”‚Β Β  β”‚Β Β  └── πŸ“‚ openfeign +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ apple +β”‚Β Β  β”‚Β Β  └── kakao + +``` +

# πŸ€Όβ€β™€οΈTeam Member -| [λ°•μž¬μ—°πŸ‘‘](https://github.com/Parkjyun) | [κΉ€κ°€μ—°πŸŒ±](https://github.com/kgy1008) | [λ°•μ„œμ§„πŸŒ±](https://github.com/PicturePark1101)| +| [πŸ‘‘λ°•μž¬μ—°πŸ‘‘](https://github.com/Parkjyun) | [πŸŒ±κΉ€κ°€μ—°πŸŒ±](https://github.com/kgy1008) | [πŸŒ±λ°•μ„œμ§„πŸŒ±](https://github.com/PicturePark1101)| |--------|------- |---------- | | | | | -| βœ”οΈServer λ¦¬λ“œ
βœ”οΈDB 섀계
βœ”οΈν™ˆν™”λ©΄ API | βœ”οΈμ†Œμ…œλ‘œκ·ΈμΈ(KAKAO, APPLE)
βœ”οΈμ‹λ‹Ή API| βœ”οΈλ§ˆμ΄νŽ˜μ΄μ§€ API
βœ”οΈμ‘±λ³΄ API | +| βœ”οΈCI/CD ꡬ좕
βœ”οΈν™ˆν™”λ©΄ AP
βœ”οΈDB 섀계 | βœ”οΈμ†Œμ…œλ‘œκ·ΈμΈ(KAKAO, APPLE)
βœ”οΈμ‹λ‹Ή API| βœ”οΈλ§ˆμ΄νŽ˜μ΄μ§€ API
βœ”οΈμ‘±λ³΄ API |