README.md

📖 프로젝트 소개

🐾반려동물 동반 가능 서비스!
반려견과 함께하는 즐거운 하루를 위해 페뜨하세요!

반려견과의 즐거운 하루를 만들어주는, Pette에 오신 걸 환영합니다!

🔗 배포 링크

⛪ 배포 링크 예시 - 네이버

---

🗣️ 프로젝트 발표 영상 & 발표 문서

🗓️ 2024.04-.01 - 2024.04.30

📺 발표 영상 예시

📑 발표 문서 예시

---

🖥️ 서비스 소개

메인 모달	메인 화면	로그인

소셜로그인	회원가입	디테일페이지

---

🧰 사용 스택

🔧 System Architecture

FE

BE

---

👥 팀 동료

FE

@burgerK98	@sonsodockje	@rnjsdywp9
강계령	김혜민	권용제

BE

@friedrice93	@JMHman	@hari1010haley
권혜연	전명환	김하림

📑 프로젝트 규칙

Branch Strategy

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

Git Convention

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

접두사	설명
Feat :	기능완성
Update :	업데이트
Bug :	버그 발견 후 해결 못하고 커밋
Fix :	버그 해결
Update :	오타 수정
Docs :	리드미 작성
Style :	스타일링, ui, 레이아웃
Test :	테스트
Refactor :	리팩
Deploy :	배포
Config :	설정

Pull Request

Title

• Style 레이아웃 개발(엔터) 본문 작성 ~다.
  로 안끝내고 짧고 정확하게 작성

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

• styled-Component 변수명 S + 변수명 (ex. Swrap)
• styled-Component는 return문 위에 작성
• 크게는 styled-Component, 그 안에서 className 사용
• Event handler 사용 (ex. handle ~)
• export방식 (ex. export default ~)
• 화살표 함수 사용

Communication Rules

• Slack 활용
• 정기 회의

📋 Documents

📜 API 명세서

📜 요구사항 정의서

📜 ERD

📜 테이블 명세서

📜 화면 정의서