diff --git a/README.md b/README.md index 94d4511..5c1a403 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # 28Delivery BackEnd +## 팀원 소개 + +||| +|-----------------|----------------------------------| +| 최동인 | | +| 조규성 | | +| 강 민 | | +| 엄은진 | | +| 이소연 | | + ## 프로젝트 개요 및 목표 28Delivery BackEnd 프로젝트는 ‘00의 민족’과 같은 **주문 관리 플랫폼**의 백앤드 부분을 **스프링 부트 기반의 모놀리식** 방식으로 개발한 팀 프로젝트입니다. 이 팀 프로젝트의 목적은 광화문 근처에서 운영될 음식점들의 배달 및 포장 주문 관리, 결제, 그리고 주문 내역 관리 기능을 제공하는 플랫폼 개발하는 것입니다. 이에 대하여 28Delivery BackEnd 프로젝트는 기능별 API를 개발하여 프론트앤드 개발자에게 필요한 데이터를 제공해주며 이러한 기능들을 자동화하여 서비스로 개발하고 관리합니다. @@ -38,12 +48,19 @@ - 사용자를 제외한 모든 엔티티의 식별자는 UUID 사용 - Audit 필드(created_at, created_by, updated_at, updated_by, deleted_at, deleted_by)로 데이터 감사 로그 기록 - 데이터 삭제시 소프트 삭제 + - 유연한 검색을 위한 QueryDSL 사용, 페이지 구현에 사 - **인증 및 보안** - JWT와 Spring Security를 활용한 인증 및 권한 관리 - BCrypt 해시 알고리즘을 사용한 비밀번호 암호화 + - 빌드 설정간 시크릿 키는 .env로 사용하여 저장 - Spring Validator를 이용한 데이터 유효성 검사 -- **테스트 코드** - - JUnit, Mockito 등을 활용한 단위 및 통합 테스트 +- **배포 및 빌드** + - AWS EC2를 통한 독립적인 배포 환경 구성 + - Docker & Docker-Compose를 이용한 컨테이너 별 빌드 설정 + - Github Action 설정으로 버전 관리와 배포 파이프라인 자동화 +- **테스트** + - JUnit, Mockito 등을 활용한 단위 및 통합 테스트 + ## 기술 스택 @@ -55,9 +72,9 @@ - **빌드 도구:** Gradle - **테스트:** JUnit 5, Mockito, Spring Test - **기타:** Lombok, Hibernate Validator -- **배포:** AWS EC2, Docker, Docker-compose +- **배포:** AWS EC2, Docker, Docker-Compose, Github Action - **API:** Google AI Studio, 주소기반산업지원 서비스 API -- **버전 관리:** Git +- **버전 관리:** Git, Github ## ERD @@ -70,7 +87,7 @@ ![시스템 설계도](./image/system.png) - 프론트앤드 부분은 담당 개발자가 개발 예정 -- kubernates는 추후 MSA로 확잘할 때 사용 얘정 +- kubernates는 추후 MSA로 확잘할 때 사용 예정 ### 실행 방법 @@ -81,15 +98,5 @@ 2. (관리자) 가게 생성 - 가게 주소 설정 3. (관리자) 메뉴 생성/수정 4. (고객) 가게 섬색 및 조회 - 메뉴 생성 및 조회 - 주문 -5. (고객) 메뉴 리뷰 남기기기 - -## 팀원 소개 - -| | | -|-----------------|----------------------------------| -| 최동인 | | -| 조규성 | | -| 강 민 | | -| 엄은진 | | -| 이소연 | | - +5. (고객) 주문시 결재 금액 확인 - 결재 진행 - 결재 완료 확 +6. (고객) 메뉴 리뷰 남기기기