[스프링심화2기_CORE팀] 프로젝트 S.A. (배달 및 포장 음식 주문 관리 플랫폼)

1단계 : 킥오프 및 요구사항 확인

기획자 : 안녕하세요~! 이번 프로젝트를 같이 진행하게된 기획자 A 입니다. 잘부탁드립니다. 이번 프로젝트는 00의 민족 같은 주문 관리 플랫폼인데요, 우선 사용자가 사용하는 부분의 프론트 앤드는 차후에 개발이 진행되기로 했습니다. 따라서, 관리자 화면들과 백앤드 개발이 필요한 상황입니다. 기존 주문 관리 플랫폼이랑 다른 점은 고객들이 온라인을 통해서도 주문을 하지만, 매장에서 직접 주문 하는것들도 받을 수 있어야 합니다. 그리고 추가 사항으로 상품 등록시에 문구를 AI를 통해 추천 받는 기능이 필요합니다. 이 내용은 요구사항에서 좀더 자세히 설명드리겠습니다~!

• 개발 요구사항 명세서 - 배달 및 포장 음식 주문 관리 플랫폼
• 프로젝트 개요
  • 주제: 배달 및 포장 음식 주문 관리 플랫폼 개발
  • 목표: 광화문 근처에서 운영될 음식점들의 배달 및 포장 주문 관리, 결제, 그리고 주문 내역 관리 기능을 제공하는 플랫폼 개발
• 운영 지역
  • 지역: 초기에는 광화문 근처로 한정하여 운영하며, 향후 확장을 고려한 지역 분류 시스템 설계 필요
  • 향후 확장성: 지역별 필터링, 지역정보 수정 및 추가 등이 가능 하도록 고려
• 음식점 분류
  • 카테고리: 다음과 같은 음식점 카테고리로 분류
    • 한식
    • 중식
    • 분식
    • 치킨
    • 피자
  • 향후 확장성: 음식점 카테고리를 추가하거나 수정할 수 있도록 유연한 데이터 구조 설계 필요
• 결제 시스템
  • 결제 방식: 카드 결제만 가능
  • PG사 연동: PG사와의 결제 연동은 외주 개발로 진행하며, 결제 관련 내역만 플랫폼의 데이터베이스에 저장
  • 결제 테이블: 결제 내역을 저장하기 위한 전용 테이블 설계
• 주문 관리
  • 주문 취소: 주문 생성 후 5분 이내에만 취소 가능하도록 제한
  • 주문 유형: 온라인 주문과 대면 주문(가게에서 직접 주문) 모두 지원
  • 대면 주문 처리: 가게 사장님이 직접 대면 주문을 접수
• 데이터 보존 및 삭제 처리
  • 데이터 보존: 모든 데이터는 완전 삭제되지 않고 숨김 처리로 관리
  • 상품 숨김: 개별 상품도 숨김 처리 가능하도록 구현(숨김과 삭제는 다른 필드에서 동작해야함)
  • 데이터 감사 로그: 모든 정보에 생성일, 생성 아이디, 수정일, 수정 아이디, 삭제일, 삭제 아이디를 포함
• 접근 권한 관리
  • 고객: 자신의 주문 내역만 조회 가능
  • 가게 주인: 자신의 가게 주문 내역, 가게 정보, 주문 처리 및 메뉴 수정 가능
  • 관리자: 모든 가게 및 주문에 대한 전체 권한 보유
• 배송지 정보
  • 필수 입력 사항: 주소지, 요청 사항
  • ‘주문’ 과 ‘배달’ 에 모두 관련된 정보 입니다!
• AI API 연동
  • 상품 설명 자동 생성: AI API를 연동하여 가게 사장님이 상품 설명을 쉽게 작성할 수 있도록 지원
  • AI 요청 기록: AI API 요청 질문과 대답은 모두 데이터베이스에 저장
• 주문 확인 방식(프론트 앤드 개발자 담당)
  • 프론트엔드 폴링: 프론트엔드에서 주기적으로 주문 확인을 위해 주문 API를 호출하는 폴링 방식 사용

프로젝트에 대한 정확한 요구사항이 전달 되었습니다. 

먼저 팀 규칙을 정했습니다. 생활 규칙은 따로 기재 하지 않을 것이고 

Pull Request

1. 2명이상의 리뷰어가 확인 되어야 한다. 
2. 각자 자기의 브랜치에서 기능 테스트가 통과된 이후에 PR 보내셔야 한다.
3. 개발 브랜치 (A,B, C) 에서 통합일을 정해서 통합하자. 
4. 이슈 발생 시 즉각 회의가 가능하다. 

Git Flow

- main
- dev
- feat 

코드 컨벤션 - 우테코 컨벤션

백엔드 개발 폴더 구조

 

API 명세

https://teamsparta.notion.site/5d6a19061f784340b54278c4584cece5?v=1372dc3ef51481229454000cbd62ee60

개빠른민족 - API 명세 | Notion

 

아키텍처 구조

AI 서비스에 대한 아키텍처도 추가될 예정입니다. 

 

ERD 설계

 

GitHub Repository Link

https://github.com/GaePpaDev/GaePpa-BackEnd-DEV

GitHub - GaePpaDev/GaePpa-BackEnd-DEV: 개빠른민족 프로젝트 백엔드 레포지토리 입니다.