Skip to content

숨, - 하루 5분의 숨통, 당신만의 해방일지 FE 레포

Notifications You must be signed in to change notification settings

2024-HY-THON/team4-fe

Repository files navigation

1. Setting

# Install package
npm install

# Run dev server
npm run dev

# Build project
npm build

## Run Production Preview
npm run preview

2. Branch Convention

ex) feat/login-ui

  • main: 서비스 운영
  • develop: 배포 전 개발용
  • feat: 기능 단위 구현
  • refactor: 코드 리팩토링
  • hotfix: 배포 버전 버그 수정

3. 폴더구조

src/
├── apis // api 호출 함수 관리
├── assets // 각종 이미지 파일 관리
├── components // 컴포넌트 관리
│   ├── common // 공통 컴포넌트
│   └── login
│       ...
├── constant // 전역 상수 관리
├── hooks // custom hook 관리
├── pages
│   └── main
│       ...
├── store // 전역 상태 관리
├── type // 공유 타입 관리
├── utils // 각종 유틸 함수 관리
├── App.tsx // 페이지별 routing
├── index.css // 전역 css 관리
└── main.tsx

4. Commit Convention

  • feat: 기능 구현, 추가
  • setting: 빌드수행, 패키지 설치, 환경 설정 수정 등
  • fix: 버그 및 오류 수정
  • style: css 파일 위주의 ui 작업
  • docs: README.md 작성, 주석 작성
  • refactor: 코드 리팩토링
  • chore: 기타 작업