Skip to content

Commit

Permalink
[docs] refactor readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PicturePark1101 authored Jul 9, 2024
1 parent 8097c0c commit ddfa9a2
Showing 1 changed file with 49 additions and 5 deletions.
54 changes: 49 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# hankki-server

# 👋 ABOUT HANKKI
<로고들어갈예정> <br>
**`WHAT ?`** 대학교를 중심으로 **8000원 이하의 메뉴를 가진 식당**을 제공하는 프로덕트

<div align = "center">
<img witdth= "600px" src="https://github.com/Team-Hankki/hankki-server/assets/109809242/275fabbb-b1c1-4589-b9e0-ec6b870dc401">
</div>

**`WHAT?`** 대학교를 중심으로 **8000원 이하의 메뉴를 가진 식당**을 제공하는 프로덕트

**`HOW?`** 서울 내의 대학 묶음 9-10개를 중심으로 50개씩 약 500개의 식당을 모아 릴리즈하고, 추후 **유저참여형**으로 운영할 계획

**`WHY?`** 치솟는 물가에 밥 한끼 먹기도 부담되는 요즘, 저렴한 식당을 공유하며 **함께** **잘 먹고 잘 살기 위해서!**

<br>

# ⚒️Stack

<div align = "center">
<img src="https://firebasestorage.googleapis.com/v0/b/stackticon-81399.appspot.com/o/images%2F1720497281719?alt=media&token=f40aa73a-b50e-43cc-bd2a-a49e3d62086d)](https://github.com/msdio/stackticon">
</div>

<br><br>
# 📍ERD
![hankki](https://github.com/Team-Hankki/hankki-server/assets/109809242/36c645b6-68e6-42b8-a9e2-9ddf790a6f4f)

<br><br>
# 📜 Covention
## Code Convetion
| 항목 | 규칙 |
Expand All @@ -40,7 +48,7 @@
| `docs` | 문서 수정 |
| `infra` | 인프라 관련 작업 |
| `hotfix` | 운영 서버 핫픽스 작업 |
|'dependency' | 의존성(아마 의존성만 추가하는 작업을 없을 것으로 예상되어 쓸 일은 없을듯)|
| `dependency ` | 의존성 |

### Branch Naming
`<Prefix>/<Issue_Number>`
Expand All @@ -59,6 +67,8 @@ close #<issue_num>

## To Reviewers
```
<br>

### Review
| PN| what|
|------|-----|
Expand All @@ -68,10 +78,44 @@ close #<issue_num>
| P4 | 반영해도 좋고 넘어가도 좋습니다 (Approve) |
|P5 | 그냥 사소한 의견입니다 (Approve) |

<br><br>
# 🗂️ 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
```
<br><br>
# 🤼‍♀️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)|
|--------|------- |---------- |
| <img width="600px" src= "https://github.com/Team-Hankki/hankki-server/assets/109809242/2276da80-d520-4548-8064-8011fb9e92a7"> | <img width="600px" src="https://github.com/Team-Hankki/hankki-server/assets/109809242/cb7addf0-a6ca-41f4-b2cc-7cb1a8a480d3"> | <img width="600px" src="https://github.com/Team-Hankki/hankki-server/assets/109809242/7d62d5c9-9b8d-4e43-a118-0ad4e69fb564"> |
|️Server 리드 <br> ✔️DB 설계<br> ✔️홈화면 API | ✔️소셜로그인(KAKAO, APPLE) <br> ✔️식당 API| ✔️마이페이지 API <br> ✔️족보 API |
|️CI/CD 구축<br> ✔️홈화면 AP<br>✔️DB 설계 | ✔️소셜로그인(KAKAO, APPLE) <br> ✔️식당 API| ✔️마이페이지 API <br> ✔️족보 API |

0 comments on commit ddfa9a2

Please sign in to comment.