OZ-Coding-School/oz_02_main-003-FE

📖 프로젝트 소개

서비스명 : 냉장고 뚝딱이
소개 : 냉장고속 재료로 만들 수 있는 레시피 공유 플랫폼
기간 : 2024년 5월 27일 ~ 6월 18일

🤷‍♂️ 냉장고에 재료는 많은데 뭐 해먹지?
🔖 그럴줄 알고 준비했어! 너를 위한 맞춤 레시피!
🍆 냉장고속 재료를 선택하고
🥑 레시피를 검색해봐~
🥕 너가 가진 재료들로 만들 수 있는 레시피를 알려줄게!

🙆‍♀️ 내가 찾던 레시피! 자랑하고 싶은 레시피! 냉장고 뚝딱이!

🔗 배포링크

https://ndd.life/

<서비스 시연>

메인 페이지

-.Clipchamp.2.mp4

레시피 조회 기능

-.Clipchamp.mp4

냉장고 페이지 시연 : 사용자가 가지고 있는 재료를 토대로 레시피 추천

-.Clipchamp.2.mp4

레시피 검색 : 협업 필터링 적용

-.Clipchamp.1.mp4

알림 기능

-.Clipchamp.mp4

🚀 기술 스택

💻 FrontEnd

협업 툴

---

👥 팀 동료

💻 FrontEnd

@woic-ej	@jjaeho0415	@backdfb
최은진	정재호	김효중

💻 BackEnd

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

📑 프로젝트 규칙

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님호칭과 존댓말 필수