배달 및 포장 음식 주문 관리 플랫폼

💡 개요

이 프로젝트는 광화문 근처에서 운영될 음식점들을 위한 배달 및 포장 음식 주문 관리 플랫폼을 개발하는 것을 목표로 합니다. 플랫폼은 음식점의 주문 관리, 결제 처리, 주문 내역 관리 기능을 제공하며, 향후 배달(라이더 할당, 배송 상태 관리) 기능은 별도 개발 예정입니다.

---

🎯 프로젝트 목적/상세

1. 모든 도메인의 CRUD 및 Search 기능

• 각 도메인 (사용자, 가게, 상품, 주문, 결제, 리뷰/평점, AI 요청 로그)
  • CRUD 구현
  • 검색 기능 포함: 기본 검색 조건 및 정렬 기능 (생성일, 수정일 순)
  • 페이지당 노출 건수: 기본 10건, 옵션으로 30건, 50건 선택 (그 외는 기본 10건으로 고정)
• 접근 권한 관리
  • 고객: 자신의 주문 내역만 조회 가능
  • 가게 주인: 자신의 가게 주문 내역, 가게 정보, 주문 처리 및 메뉴 수정 가능
  • 관리자: 모든 가게 및 주문에 대한 전체 권한 보유

2. 사용자 인증 기능

• 회원가입 (POST /api/auth/signup)

  • username: 최소 4자 이상, 10자 이하이며 소문자(a~z), 숫자(0~9)로 구성
  • password: 최소 8자 이상, 15자 이하이며 알파벳 대소문자, 숫자, 특수문자 포함
  • 사용자 권한: CUSTOMER, OWNER, MANAGER, MASTER

• 로그인 및 로그아웃

  • JWT 기반 인증 (Access Token, Refresh Token 발급 및 관리)
  • API 엔드포인트: POST /api/auth/login, POST /api/auth/logout

3. 결제 시스템

• 카드 결제만 지원 (PG사 연동을 통해 결제 정보 저장)
• 결제 테이블 운영 (결제 내역 관리)

4. 주문 관리

• 주문 생성 후 5분 이내 취소 가능
• 온라인 주문 & 대면 주문 지원 (가게에서 직접 주문 가능)
• 주문 상태 관리 (진행 중, 완료 등 단계별 상태 업데이트)

5. 배송지 정보 관리

• 배송지 정보 (주소, 요청사항) 필수 입력
• 배송 관련 추가 기능 개발 예정

6. 가게 검색 관리

• 가게 검색 시 평균평점이 함께 출력되도록 구현

7. 리뷰 및 평점 기능

• 주문 기반 리뷰 및 평점 저장 (1~5점 평점 시스템 운영)
• 가게 목록 조회 시 평점 계산 및 노출 (N+1 문제 고려)
• 주문 검색 시 음식점 리뷰 리스트 표시

8. AI API 연동

• 상품 설명 자동 생성
  • Google Cloud Generative Language API 연동 (Gemini-1.5 Flash Latest 모델 활용)
  • 음식점 사장님이 상품 설명을 쉽게 작성할 수 있도록 지원
• AI 요청 기록
  • AI API 요청과 응답 문장을 DB에 저장
  • 요청 글자 수 제한 + 응답을 간결하게 50자 이하로 요청하여 최적화

9. 클라우드 서비스 배포

• AWS 프리 티어 활용하여 실제 서비스 배포
• 배포 방식: 파일 업로드, Docker 컨테이너 등 다양한 방식 지원

10. Spring Security 고도화

• 관리자 권한 설정
  • 가게 추가 시 관리자 권한 사용자만 가능

11. API 문서화

• RestDocs을 활용한 API 문서화

12. 테스트 코드 작성

• 각 도메인 주요 API에 대해 통합 테스트 작성 (성공/실패 케이스 포함)

13. QueryDSL 구현

• 지점 검색 시 카테고리 & 지점 이름 복합 필터링

---

📌 추가 고려 사항

✅ 데이터 관리

• 완전 삭제 대신 숨김 처리 방식 적용
• 감사 로그 기록 (생성일, 수정일, 삭제일 정보 포함)

✅ 확장성 고려

• 지역 및 카테고리 확장 가능하도록 설계

✅ 보안 강화

• Spring Security를 활용한 접근 권한 관리

---

🚀 서비스 구성 및 실행 방법

1. 환경 설정

• Java 17
• Spring Boot 3.x
• Gradle
• Docker (선택)
• AWS 프리 티어 (배포 환경)

2. 실행 방법

2-1. 로컬 환경에서의 실행방법

# 프로젝트 클론
git clone https://github.com/2ana9/delievery-management.git
cd delivery-management

# 환경변수 설정
cp .env.example .env

# 빌드 및 실행
./gradlew bootRun

# 빌드 및 실행
$ ./gradlew build
$ java -jar build/libs/delivery-management-0.0.1-SNAPSHOT.jar

2-2. 배포환경(AWS EC2)에서의 실행방법

3. API 문서 확인

• postman UI: postman
• restdocs: restdocs(작성중!)

---

🏗 기술 스택

분야	기술
Backend	Spring Boot, JPA (ORM 프레임워크), OpenFeign, QueryDSL (동적 쿼리 생성), Specification (JPA에서 제공하는 동적쿼리 생성 인터페이스) Kibana(Elasticsearch 데이터 시각화 도구)
Security	Spring Security, JWT (토큰 기반 인증)
Database	PostgreSQL, Elasticsearch (분산검색 및 분석엔진), OpenSearch(실시간 검색 및 로그 분석도구)
Cloud	AWS EC2 (가상 서버 호스팅)
Chache	Redis (캐싱 및 세션 관리), Spring chache(Spring의 캐싱 추상화), Jedis(Redis의 클라이언트 라이브러리)
API Docs	RestDocs (API 문서화도구)
AI 연동	Google Generative Language API (Gemini-1.5)
Test	Spring Boot Test, Spring Security Test, JUnit, Mockito

---

📜 ERD

---

🎯 팀원 역할분담

역할	담당자	세부 업무
리뷰 및 평점 관리	한석규	- 리뷰 시스템 CRUD 설계 및 구현 - 1~5점까지의 평점을 기록하는 기능 구현 - 주문 한건당 리뷰 한건 작성가능 - softDelete 구현 - 리뷰 필터링, 정렬 기능 구현 - 주문 검색 시 음식점 리뷰 리스트 표시
주문(온라인,오프라인) 관리	강혜주	- 주문 시스템 CRUD 설계 및 구현 - 온라인/오프라인 주문 흐름 구현 - 주문 생성 후 5분 이내 취소 가능기능 구현 - softDelete 구현 - 주문 상태 추적 관리 - 주문 내역 조회 필터링, 정렬 기능 구현 - 결제내역 관리
회원주소 및 지역코드 관리	문준영	- 회원 배송지 주소 관리 시스템 CRUD 설계 및 구현 - 배송지역 확장성을 고려한 Elasticsearch 사용
가게,음식 카테고리 관리	신다은	- 가게, 음식 카테고리 시스템 CRUD 설계 및 구현 - 가게,음식 카테고리 관리 시 관리자 권한만 접근가능하도록 구현 - softDelete 구현 - Specification을 사용한 검색 필터링 기능 구현
로그인 및 회원가입,음식메뉴 관리	유남규	- 회원가입, 로그인 설계 및 구현 - 카카오 로그인 등의 Open API 로그인 구현 - 회원인증처리 및 JWT 인증토큰 구현
DB 설계 및 관리	모두
AI API 연동	유남규	- Google Generative Language API (Gemini-1.5) 를 사용한 메뉴 설명 자동화 구현 - AI API 요청/응답 로그 DB 저장
클라우드 배포	한석규	- EC2 인스턴스 생성 및 초기설정 - 보안 그룹 설정 (포트 개방 등) - 애플리케이션 및 필요한 라이브러리 설치 - RDS 인스턴스 생성 및 설정 - RDS 보안 그룹 설정 (EC2와의 연결 허용) - 애플리케이션의 환경 변수 설정 (RDS 데이터베이스 연결 정보 포함) - 애플리케이션 배포 (배포 자동화 스크립트 적용 등)

---

🔗 참고 링크

• Google AI API 문서
• Spring Security 공식 문서
• QueryDSL 공식 문서
• Specification 공식 문서