diff --git a/README.md b/README.md index 0dd885ce..fa39644f 100644 --- a/README.md +++ b/README.md @@ -1 +1,211 @@ -# nabi-market-server +## 나비장터 + +> 물물교환의 장이 되는 곳 - 나비장터 +> + +## 📣 프로젝트 목적 + +> 시장가치가 떨어진 물건을 비슷한 가치의 물건과 교환하는 과정을 쉽게 만들어주는 서비스입니다. +> + +## 🧐 팀원소개 + +| Tech Leader | Scrum Master | Developer | +| --- | --- | --- | +| https://github.com/hi-june | https://github.com/BeommoKoo-dev | https://github.com/born-A | +| | | | + +## 🛠 기술스택 + +### 개발 환경 + + + + + + + + + + + + + + + +### 협업 툴 + + + + + + +### 기타 + + + + + +## 📋 프로젝트 아키텍처 + +
+ +
+ +## 📋 ERD 다이어 그램 + ++ +
+ +## 📁 패키지 구조 + +- `global` : 도메인 전체에 적용되는 base entity, config, security 등을 담고있는 패키지. +- `domain` : 각 도메인의 root가 되는 패키지 . +- `api` : 레이어 아키텍쳐 중 컨트롤러가 위치한 패키지. +- `dto` : 계층간 통신을 위한 dto가 담긴 패키지. +- `service` : 레이어 아키텍쳐 중 서비스가 위치한 패키지. +- `entity` : JPA 엔티티 클래스, Enum 등이 들어간 패키지. +- `domain` : 각 도메인 엔티티와 레포지토리, 도메인에 필요한 enum들을 갖고 있는 패키지. +