diff --git a/README.md b/README.md index a038a26c..f14d9a06 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,130 @@ -## Bingterpark +# Bingterpark -[노션 페이지](https://www.notion.so/backend-devcourse/2-BingterPark-4ecfb3943d9c4a8f9bb83f72876b6a80) -[ERD](https://www.erdcloud.com/d/ZadArGCaQXFcxZuu8) +![](https://i.imgur.com/xRGQU4e.jpg) + +
+ +## 📌 프로젝트 목적 + +> 실제 서비스인 **인터파크 티켓**의 API를 클론코딩하여 +> 데브코스에서 배웠던 내용을 적용해보고 협업을 경험해봅니다. + +
+ +## ⌛️ 프로젝트 기간 + +> 2023.12.15 ~ 2024.01.12 (4주) + +
+ +## 👥 팀원 + +| Product Owner | Scrum Master | Developer | Developer | Developer | Developer | +|:----------------------------------:|:-----------------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|:-------------------------------:| +| [김경훈](https://github.com/KarmaPol) | [김대휘](https://github.com/marooo326) | [김별이](https://github.com/byulcode) | [박영재](https://github.com/park0jae) | [이한나](https://github.com/annahxxl) | [조은비](https://github.com/eunbc) | + +
+ +## 협업 링크 + +🐘 [팀 페이지](https://www.notion.so/backend-devcourse/2-BingterPark-4ecfb3943d9c4a8f9bb83f72876b6a80) + +📌 [코드 컨벤션](https://www.notion.so/backend-devcourse/0ebe193cfaeb45db9c9377fa6eb8d38a) + +👨‍💻 [기능 명세서](https://www.notion.so/backend-devcourse/915c54641e6d4bdca96524a178d860b6?v=18e598a3b9234189a69cef24d2abd985) + +🚀 [RBF(작성중)]() + +✨ [회고(작성중)]() + +
+ +## 🛠️ 기술 스택 + +### 개발 환경 + +

+ + + + + + + +

+ +

+ + + + + +

+ +

+ + + +

+ +

+ + + +

+ +### 협업 도구 + +

+ + + + +

+ +
+ +## 프로젝트 설계 + +### ERD + +![](https://i.imgur.com/Egu30AX.png) + +
### 모듈 구조 ![img.png](img.png) -#### api +
+ +#### [api 모듈] + +| api-member | api-event | api-booking | +|:----------:|:---------:|:-----------:| +| 회원 도메인 | 공연 도메인 | 예매 도메인 | + +
+ +#### [batch 모듈] -- api-member - 회원 도메인 -- api-event - 공연 도메인 -- api-booking - 예매 도메인 +- 스프링 배치 모듈 -#### batch +
-스프링 배치 모듈 +#### [core 모듈] -#### core +| **core-domain** | **core-infra** | **core-infra-es** | **core-security** | +|:---------------:|:-------------------:|:---------------------------------------------------:|-----------------------| +| JPA 엔티티, 레포지토리 | QueryDsl, RDB 설정 파일 | elastic search 설정 파일,
document, searchRepository | Spring security 설정 파일 | -- core-domain - JPA 엔티티, 리포지토리 -- core-infra - queryDsl, RDB 설정 파일 -- core-infra-es - elastic search 설정 파일, document, searchRepository -- core-security - spring security 설정 파일 +
+ +### Github Flow 전략 + +![](https://velog.velcdn.com/images/gmlstjq123/post/04588f97-e776-4829-a519-58f7c93b6c4a/image.png) + +
## 실행 방법 @@ -40,7 +135,9 @@ 5. ELK 스택 실행 ```docker-compose up -d``` 6. api-booking, api-event, api-member 각 모듈에서 스프링 어플리케이션 실행 +
+ ## 테스트 방법 - 통합 http 테스트는 /http/bingterpark.http에 있습니다. -- 어드민 플로우, 유저 플로우 http 코드를 위에서부터 하나씩 실행하시면 됩니다. +- 어드민 플로우, 유저 플로우 http 코드를 위에서부터 하나씩 실행하시면 됩니다.