README.md

📖 프로젝트 소개

서비스명 : 오키버리 (okivery)
기간 : 2024년 4월16일 ~ 5월 20일

📱 한국에 사는 외국인들이 사용하는 배달음식 어플!!
👌 에피타이저부터 디저트까지 모두 한 번의 주문으로 해결!!
😢 기존의 배달 어플은 언어와 결제라는 큰 벽이 존재하여 외국인들이 사용하기에 많은 어려움이 존재했으며, 한 주문에 한 식당만 선택하는 번거로움도 존재했습니다.
🧐 저희는 이러한 문제점들을 개선하여 외국인들이 사용하기 편한 배달 어플을 만들기로 했습니다!!

🔗 배포 링크

https://okivery.duckdns.org/

📽️ 시연 영상

회원가입

---

로그인

---

주소 등록

현재 평택지역으로 서비스가 제한 되어있습니다.

default.mp4

---

메뉴 담기

---

결제 및 결제 내역 확인

🚀 기술 스택

💻 FrontEnd

💻 BackEnd

협업 툴

---

👥 팀 동료

💻 BD

• 장유위
• 천지원

💻 FrontEnd

@woic-ej	@jjaeho0415
최은진	정재호

💻 BackEnd

@sub-blind	@KangJeongHo1	@newbission
김재섭	강정호	윤준명

📑 프로젝트 규칙

Branch Strategy

• main / dev 브랜치 기본 생성
• main과 dev로 직접 push 제한
• PR 전 최소 1인 이상 승인 필수

Git Convention

1. 적절한 커밋 접두사 작성
2. 커밋 메시지 내용 작성
3. 내용 뒤에 이슈 (#이슈 번호)와 같이 작성하여 이슈 연결

접두사	설명
Feat :	새로운 기능 구현
Add :	에셋 파일 추가
Fix :	버그 수정
Docs :	문서 추가 및 수정
Style :	스타일링 작업
Refactor :	코드 리팩토링 (동작 변경 없음)
Test :	테스트
Deploy :	배포
Conf :	빌드, 환경 설정
Chore :	기타 작업

Pull Request

Title

• 제목은 '[Feat] 홈 페이지 구현'과 같이 작성합니다.

PR Type

• FEAT: 새로운 기능 구현
• ADD : 에셋 파일 추가
• FIX: 버그 수정
• DOCS: 문서 추가 및 수정
• STYLE: 포맷팅 변경
• REFACTOR: 코드 리팩토링
• TEST: 테스트 관련
• DEPLOY: 배포 관련
• CONF: 빌드, 환경 설정
• CHORE: 기타 작업

Description

• 구체적인 작업 내용을 작성해주세요.
• 이미지를 별도로 첨부하면 더 좋습니다 👍

Discussion

• 추후 논의할 점에 대해 작성해주세요.

Code Convention

BE

• 패키지명 전체 소문자
• 클래스명, 인터페이스명 CamelCase
• 클래스 이름 명사 사용
• 상수명 SNAKE_CASE
• Controller, Service, Dto, Repository, mapper 앞에 접미사로 통일(ex. MemberController)
• service 계층 메서드명 create, update, find, delete로 CRUD 통일(ex. createMember)
• Test 클래스는 접미사로 Test 사용(ex. memberFindTest)

FE

• 함수명, 변수명, Hooks camelCase
• 컴포넌트명 PascalCase
• 상수명 SCREAMING_SNAKE_CASE
• 배열과 객체는 반드시 리터럴로 선언
• Boolean 타입의 변수의 식별자는 is, has, can 의 접두사를 사용하여 선언
• assets 폴더 내 파일 이름 camelCase
• Event handler 사용 (ex. handle ~)
• export방식 (ex. export default ~)
• 화살표 함수 사용
• 주석은 위에 사용

Communication Rules

• Discord 활용
• 정기 회의
• 00님호칭과 존댓말 필수