/project-example

프로젝트 Github 진행 방식 예시

📖 프로젝트 소개

더 이상 독서는 혼자만의 취미가 아니다❌ 책을 사랑하는, 책과 가까워지고 싶은, 혹은 비슷한 사람들끼리 취미를 공유하고 싶어하는 모두가 모여 하나의 마을을 형성하는 프로젝트 예시는 사용자 모두가 이웃처럼 서로의 지식을 나누고 책을 공유합니다. 함께하는 독서 습관을 만들어주는 서비스, 프로젝트 예시에 오신 걸 환영합니다!

🔗 배포 링크

⛪ 배포 링크 예시 - 네이버

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

🗓️ 2024.00-.00 - 2024.00.00

📺 발표 영상 예시

📑 발표 문서 예시

🖥️ 서비스 소개

메인 화면 1 메인 화면 2 소셜 로그인 1
MainPage1 MainPage2 Login1
소셜 로그인 2 나눔글 등록 및 수정 나눔글 목록
Login2 CreateUpdateShare ShareList
나눔글 이미지 업로드 나눔글 댓글 나눔 상태 토글
UpdateShareImg ShareComment ShareStatus
나눔 게시글 검색 요청글 등록 요청글 수정
SearchShare CreateRequset UpdateRequest
요청글 댓글 요청글 검색 도서 평점 등록
RequestComment SearchRequest CreateRating
도서 평점 수정 및 삭제 마이페이지 1 마이페이지2
UpateRating MyPage1 MyPage2

🧰 사용 스택

🔧 System Architecture

FE




BE




👥 팀 동료

FE


@GithubID
@GithubID
@GithubID
@GithubID
홍길동 김00 강00 송00

BE


@GithubID
@GithubID
@GithubID
박00 이00 한00

📑 프로젝트 규칙

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

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

Communication Rules

  • Discord 활용
  • 정기 회의

📋 Documents

📜 API 명세서 예시

📜 요구사항 정의서 예시

📜 ERD 예시

📜 테이블 명세서 예시

📜 화면 정의서 예시