👨‍👧‍👦 팀 소개

팀명 : 위대한 렛츠비

👥 팀원 및 역할

분야	이름	포지션	내용
기획	오민지	📈 PM, 서비스 기획	전체 프로젝트 관리 및 유저 리서치, 와이어프레임 제작, 서비스 기능 명세서 제작
기획	신예진	📋 서비스 기획	데스크/유저 리서치, 와이어프레임 제작, 서비스 기능 명세서 제작
기획	최수영	📊 서비스 기획	데스크/유저 리서치, 서비스 기능 명세서 제작
디자인	설정원	🎨 디자인 리드	디자인시스템/그래픽
디자인	이어령	🎨 디자인	gui/브랜딩
개발	박인애	📱 프론트엔드 리드	개발 환경 세팅, 컴포넌트 개발, API 연동
개발	김진희	📱 프론트엔드	개발 환경 세팅, 컴포넌트 개발, API 연동
개발	문희상	💻 백엔드 리드	ERD 작성, API 개발 , 인프라 구축
개발	박준형	💻 백엔드	ERD 작성, API 개발

Front-End

🎮 시연 영상

https://youtu.be/6Pw6TpnJlIs

🛠️ 기술 스택

• React

  • 동적이고 상호작용이 필요한 UI를 효율적으로 만들기 위해 사용
  • 컴포넌트 기반 구조 덕분에 코드 재사용이 가능하고, 개발 속도 및 유지보수에 유리
  • version: 18.3.1

• TypeScript

  • 자바스크립트에 정적 타입을 추가해 코드 안정성과 가독성 향상
  • 타입 체크 덕분에 오류를 미리 발견하고 버그를 줄이는 데 기여
  • version: 5.5.4

• Vite

  • 빠른 개발 환경을 제공
  • 즉각적인 핫 모듈 교체 기능으로 개발 피드백이 빠르고, 전통적인 번들러보다 속도가 빠름
  • version: 5.4.2

• TailwindCSS

  • HTML 내에서 유틸리티 클래스만으로 빠르고 일관된 스타일링을 가능하게 함
  • 커스텀 CSS 없이도 일관된 디자인 유지에 유리
  • version: 3.4.10

• Vercel

  • 손쉬운 배포와 글로벌 확장성을 제공하는 클라우드 플랫폼
  • CI/CD 통합을 통해 빠르고 효율적인 배포 프로세스 지원

• Axios

  • Promise API를 활용하는 HTTP 비동기 통신 라이브러리
  • version: 1.7.6

• React Router Dom

  • React 페이지 전환 라이브러리
  • version: 6.26.1

• ESLint

  • TS 코드 문법 및 코딩 스타일을 검사해주는 라이브러리
  • version: 9.9.1

• Prettier

  • VSCode 환경 React 프로젝트에 코드를 정해진 스타일대로 포매팅하는 라이브러리
  • version: 3.3.3

🙏 협업 툴

• 

🌟 페이지 소개

🌟 메인홈

• 기업 채용 일정 상태 대쉬보드 확인
• 기업별 투두 상태 확인
• 마감 임박 알림
• 기업 채용 일정 추가

🌟 캘린더

• 월별 일정 모아보기

• 개인 일정 추가, 수정, 삭제

• 기업별 투두 상태 관리

• 기업 채용 일정 추가

🌟 내 지원현황 보기

• 전체 기업 채용 일정 관리

• 진행 중 기업의 전형, 투두 관리

• 진행 중 기업의 아카이브 관리

• 마감 기업의 복기노트 관리

🌟 커리어 관리

• 필살기 경험 관리

☀️ Commit Convention

Rules

1. Git Flow

작업 시작 시 선행되어야 할 작업은 다음과 같습니다.

1. issue를 생성합니다.
2. feature branch를 생성합니다.
3. add → commit → push → pull request 를 진행합니다.
4. pull request를 develop branch로 merge 합니다.
5. 이전에 merge된 작업이 있을 경우 다른 branch에서 진행하던 작업에 merge된 작업을 pull 받아옵니다.
6. 종료된 issue와 pull request의 label을 관리합니다.

2. IntelliJ

IntelliJ로 작업을 진행하는 경우, 작업 시작 시 선행되어야 할 작업은 다음과 같습니다.

1. 깃허브 프로젝트 저장소에서 issue를 생성합니다.
2. 생성한 issue 번호에 맞는 feature branch를 생성함과 동시에 feature branch로 checkout 합니다.
3. feature branch에서 issue 단위 작업을 진행합니다.
4. 작업 완료 후, add → commit을 진행합니다.
5. remote develop branch의 변경 사항을 확인하기 위해 pull 받은 이후 push를 진행합니다.
6. 만약 코드 충돌이 발생하였다면, IntelliJ에서 코드 충돌을 해결하고 add → commit을 진행합니다.
7. push → pull request (feature branch → develop branch) 를 진행합니다.
8. pull request가 작성되면 작성자 이외의 다른 팀원이 code review를 진행합니다.
9. 최소 한 명 이상의 팀원에게 code review와 approve를 받은 경우 pull request 생성자가 merge를 진행합니다.
10. 종료된 issue와 pull request의 label과 milestone을 관리합니다.

3. Etc

준수해야 할 규칙은 다음과 같습니다.

1. develop branch에서의 작업은 원칙적으로 금지합니다. 단, README 작성은 develop branch에서 수행합니다.
2. commit, push, merge, pull request 등 모든 작업은 오류 없이 정상적으로 실행되는 지 확인 후 수행합니다.

Branch

1. Branch

branch는 작업 단위 & 기능 단위로 생성된 issue를 기반으로 합니다.

2. Branch Naming Rule

branch를 생성하기 전 issue를 먼저 작성합니다. issue 작성 후 생성되는 번호와 domain 명을 조합하여 branch의 이름을 결정합니다. <Prefix>/<Issue_Number>-<Domain> 의 양식을 준수합니다.

3. Prefix

• main : 개발이 완료된 산출물이 저장될 공간입니다.
• develop: feature branch에서 구현된 기능들이 merge될 default branch 입니다.
• feature: 기능을 개발하는 branch 입니다. 이슈 별 & 작업 별로 branch를 생성 후 기능을 개발하며 naming은 소문자를 사용합니다.

4. Domain

• user, home, error, config

5. Etc

• feature/7-user, feature/5-config

Issue

1. Issue

작업 시작 전 issue 생성이 선행되어야 합니다. issue 는 작업 단위 & 기능 단위로 생성하며 생성 후 표시되는 issue number 를 참조하여 branch 이름과 commit message를 작성합니다.

issue 제목에는 기능의 대표적인 설명을 적고 내용에는 세부적인 내용 및 작업 진행 상황을 작성합니다.

issue 생성 시 github 오른편의 assignee, label을 적용합니다. assignee는 해당 issue 담당자, label은 작업 내용을 추가합니다.

2. Issue Naming Rule

[<Prefix>] <Description> 의 양식을 준수하되, prefix는 commit message convention을 따릅니다.

3. Etc

[feat] 약속 잡기 API 구현
[chore] spring data JPA 의존성 추가

---

Commit

1. Commit Message Convention

[<Prefix>] #<Issue_Number> <Description> 의 양식을 준수합니다.

• feat : 새로운 기능 구현 [feat] #10 구글 로그인 API 기능 구현
• design : 새로운 컴포넌트 구현, 디자인 수정 [design] #11 캘린더 칩스 구현
• fix : 코드 오류 수정 [fix] #12 회원가입 비즈니스 로직 오류 수정
• docs : README나 wiki 등의 문서 개정 [docs] #14 리드미 수정
• refactor : 내부 로직은 변경 하지 않고 기존의 코드를 개선하는 리팩터링 [refactor] #15 코드 로직 개선
• chore : 의존성 추가, yml 추가와 수정, 패키지 구조 변경, 파일 이동 [chore] #21 yml 수정, [chore] #22 lombok 의존성 추가
• test: 테스트 코드 작성, 수정 [test] #20 로그인 API 테스트 코드 작성
• style : 코드에 관련 없는 주석 달기, 줄바꿈
• rename : 파일 및 폴더명 수정

Pull Request

1. Pull Request

develop & main branch로 merge할 때에는 pull request가 필요합니다. pull request의 내용에는 변경된 사항에 대한 설명을 명시합니다.

2. Pull Request Naming Rule

[<Prefix>] <Description> 의 양식을 준수하되, prefix는 commit message convention을 따릅니다.

3. Etc

[feat] 약속 잡기 API 구현
[chore] spring data JPA 의존성 추가