Skip to content

Plan-You/PlanU-FE

Repository files navigation

PlanU-FE

- 로컬서버 http -> https로 적용

- clone or pull 받고 npm install -> npm run init-https 실행한 이후 루트 경로에 init-https.sh파일이랑 .pem 파일 2개 정상적으로 설치 됐는지 확인하고 npm run dev 실행 -> https 적용

- types폴더 안에 api명세서에 명시된 카테고리별로 분리 (1) calendar.d.ts (2) group.d.ts (3) chatting.d.ts (4) friend.d.ts (5) user.d.ts (6) response.d.ts(공통 응답 데이터 타입: resultCode, resultMsg) (7) form.d.ts (8) inputList.d.ts (9) global.d.ts (10) locationInfo.d.ts
  • 타입 정의할때 타입이름 : I + 메소드타입 + api종류 + (Response or Request) + bodyType 이런식으로 타입 정의 필수
  • 관련 타입(요청, 응답 body)을 묶어서 한 주석으로 위에 어떤 api에 대한 타입 정의인지 한글로 명시 필요
  • 만약 응답 body의 타입이 response.d.ts에 있는 공통타입이면 따로 정의 X

ex. /types/friend.d.ts // 친구요청 api type IPostRequestFriendRequestBodyType{} type IPostRequestFriendResponseBodyType{}

📖 프로젝트 소개

약속잡기 / 모임 관리 서비스 (친구들과의 약속, 단체 모임, 팀플)


🚀 기술 스택

💻 FrontEnd


협업 툴

Deploy


👥 팀 동료

💻 FrontEnd


@jjaeho0415


@shuding0307


@Eun0713

정재호 이수현 이다은

📑 프로젝트 규칙

작업해야할 내용들은 모두 canvan board에 작성하고 issue로 연결한 후 그 작업에 해당하는 브랜치를 새로 파서 작업 진행

Branch Strategy

  • main / dev 브랜치 기본 생성(main은 배포 branch, dev는 개발 브랜치)
  • main과 dev로 직접 push 제한
  • 작업 브랜치 명은 canvan으로 팠던 issue 번호에 맞게 (ex. 커밋 접투사/#이슈번호 => style/#30 or feat/#32)

Git Convention

  1. 적절한 커밋 접두사 작성
  2. 커밋 메시지 내용 작성
접두사 설명
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: 기타 작업

Code Convention

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

Communication Rules

📌 회의 관련

  • 정기 회의 : 매주 월요일 오후 4시 30분
  • 회의 참석 불가 시, 하루 전까지 말하기

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages