hankki-server

👋 ABOUT HANKKI

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

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

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

🤼‍♀️Team Member

👑박재연👑	🌱김가연🌱	🌱박서진🌱
✔️CI/CD 구축 ✔️DB 설계 ✔️홈화면 API ✔️제보 API	✔️소셜로그인(KAKAO, APPLE) ✔️식당 API ✔️Discord 알림 구현	✔️마이페이지 API ✔️족보 API

⚒️Stack

🏗️Architecture

📍ERD

📜 Covention

Code Convetion

항목	규칙
Class	PascalCase
Function	camelCase
Variable	camelCase
DB Table	snake_case
ENUM, Contatant	PascalCase

♣️Git Convention

prefix

type	what
feat	구현
fix	수정
refac	리팩토링
chore	패키지 구조 수정
docs	문서 수정
infra	인프라 관련 작업
hotfix	운영 서버 핫픽스 작업
dependency	의존성

Branch Naming

<Prefix>/<Issue_Number>

Commit Message

[<Prefix>] <Description>

Pull Request

title : [<Prefix>] <Description>

## Related Issue 📌
close #<issue_num>

## Description ✔️
- 

## To Reviewers

🗂️ Package

├── 🗂️ Dockerfile-dev
├── 🗂️ server-yml
└── 🗂️ org.hankki.hankkiserver
│   └── 🗂️ hankkiserver
│       ├── 💽 HankkiserverApplication
│       │   ├── 🗂️ api
│       │   │   ├── 📂 advice
│       │   │   ├── 📂 DomainA
│       │   │   │   ├── controller
│       │   │   │   │   └── request
│       │   │   │   └── service
│       │   │   │       └── response
│       │   │   │       └── commmand
│       │   ├── 🗂️ auth
│       │   │   ├── 📂 config
│       │   │   ├── 📂 filter
│       │   │   └── 📂 jwt
│       │   ├── 🗂️ common
│       │   │   ├── 📂 code
│       │   │   ├── 📂 exception
│       │   ├── 🗂️ domain
│       │   │   ├── 📂 common
│       │   │   ├── 📂 config
│       │   │   ├── 📂 DomainA
│       │   │   │   ├── model
│       │   │   │   └── repository
│       │   └── 🗂️ external
│       │       ├── 📂 config
│       │       └── 📂 openfeign
│       │            ├── apple
│       │            └── kakao