1. 팀 소개

팀 이름 : 9글링 개발팀

프로젝트 명 : 음식 주문 서비스

소개

• 한 줄 정리 : 음식점들의 배달 주문을 쉽고 빠르게 관리하는 플랫폼
• 내용 : 사용자는 음식점을 검색하고 메뉴를 선택하여 주문할 수 있으며, 음식점은 주문 내역과 결제 상태를 확인할 수 있습니다.

1.1. 팀원 역할 분담

도상원

• 인증, 사용자 도메인 개발
• 배포 담당

유민아

• 가게 도메인 개발
• 상품 상세 옵션 도메인 개발
• README 작성

이원규

• AI 연동 개발
• 발표 담당

정민지

• 상품 도메인 개발
• 상품 상세 옵션 도메인 개발
• PPT 작성

조유리

• 주문 도메인 개발
• README 작성

차준호

• 결제 도메인 개발
• 리뷰 도메인 개발

2. 서비스 구성

2.1. 인프라, 기술 스택

• Java 17(LTS)
• Spring Boot 3.4.10
• Mysql 8.x
• Redis 7.x
• Spring Data JPA
• Spring Security
• Swagger
• Docker
• AWS

2.2. ERD

🔗 ERD 링크

2.3. 실행 방법

배포 서버 사용하기

🔗 배포서버 링크

docker-compose 로 실행하는 방법

1. 프로젝트 압축 해제
2. cd docker
3. docker compose -f docker-compose.local.yml up -d
4. cd ..
5. ./gradlew clean build
6. java -jar build/libs/foodorder-0.0.1-SNAPSHOT.jar

2.4. 버전 관리 규칙

branch 생성 규칙

깃허브에서 issue를 발행하고, feature/issue 번호로 브랜치를 생성한다.

Commit/PR 접두사 규칙

• feature: 새로운 기능 추가
• refactor: 기능이나 동작은 변경하지 않지만, 코드의 가독성, 유지보수성 등을 향상하기 위해 코드를 수정
  • 함수나 메서드를 더 작은 단위로 분리
  • 변수 이름을 명확하게 변경
  • 중복 코드를 제거하는 등의 작업
• test: 테스트 코드 추가
• fix: 버그 수정
• infra: 시스템의 기본 구조와 운영 환경을 설정
• docs: 문서 수정
• style: 코드 포맷팅등 코드 변경이 없는 경우
  • 줄바꿈, 공백을 정리 등
• chore: 프로젝트 구조 변경
  • 빌드 업무 수정, 패키지 매니저 수정 등
• merge: 브랜치 병합, 병합 충돌 해결

3. 프로젝트 목적 및 상세

3.1. 프로젝트 목적

상품 설명 작성에 어려움을 겪는 가게 사장님들이 보다 쉽게 상품 설명을 작성할 수 있도록 외부 AI 서비스인 Gemini를 연동했습니다. 또한 협업 환경에서 요구사항을 구체화하고, 개발 및 문서화, 배포 등 개발 프로세스 전반을 경험하는 것을 목적으로 프로젝트를 진행하였습니다.

3.2. API docs

🔗 Swagger UI 링크

3.3. API 흐름

1. MASTER와 MANAGER는 회원가입 후 승인이 있어야 로그인할 수 있다.
2. OWNER는 가게 생성 후 메뉴를 생성할 수 있다.
3. 메뉴 생성 이후에도 옵션을 추가할 수 있다.
4. 옵션 생성 이후에도 옵션값을 추가할 수 있다.
5. USER는 주문 생성 후 결제를 생성할 수 있다.
6. 주문은 created,pending 상태에서만 취소할 수 있다.
7. USER는 주문 완료 후 가게 리뷰를 작성할 수 있다.

3.4. API 권한별 기능 명세

🔗 권한별 기능 명세 링크