Skip to content

DY-MAKE/Withme_React

Repository files navigation

Withme_React

This project was bootstrapped with Create React App.

Available Scripts

yarn install

install Dependencies modules

yarn dev

개발 모드에서 프로젝트 실행

Default Port: 3000

yarn dev:nb

no browser mode

개발 모드에서 프로젝트 실행, 브라우져를 함께 실행하지 않음

Default Port: 3000

yarn prod

프로덕션 모드에서 프로젝트 실행

Default Port: 80

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Sourcemap 생성은 비활성화 되어있음

yarn lint

Eslint 실행

yarn lint:fix

Eslint 실행과 자동으로 수정 가능한 항목들을 수정

Directory Structure

├── src
|  ├── components
|  |  └── Custom Components
|  ├── hooks
|  |  └── Custom Hooks
|  ├── pages
|  |  └── Routed Pages
|  ├── index.tsx
|  ├── react-app-env.d.ts
|  ├── reportWebVitals.ts
|  └── setupTests.ts
├── craco.config.js
├── package.json
├── tsconfig.json
├── tsconfig.paths.json
├── .env.development
├── .env.production
└── yarn.lock

Environment File

CRA에서 기본으로 제공해주는 세팅 사용

.env.development => dev 모드에서 사용됨 .env.production => build 시에 사용됨

환경변수 추가시 참고사항

REACT_APP_varblename=value 형식으로 추가

이외의 형식은 Craco에서 걸러버림

Branch

브랜치 관리 방법

master

가능한 오류 없이 유지시키기

만약 병합 이후 오류가 발생한다면 해당 커밋은 revert

feature/

새로운 기능 개발/개선등 작업이 필요할 때 사용

브랜치에서의 개발이 완료되면 master 브랜치로 병합

Example

feature/UserLogin feature/OptimizeSearchEngine

Commit Convention

프로젝트 커밋에 관련된 규칙

Commit Message

커밋 메세지에 들어가야 하는 정보

  • CommitType: 커밋 종류
  • title: 커밋에 대한 간단한 요약
  • description: 세부적인 수정 사항, '-' 을 줄 시작에 입력

Commit Type

  • feat (Feature): 새로운 기능 추가
  • fix: 버그 수정
  • docs: 문서 수정
  • style: 코드 포매팅
  • ref (Refactor): 코드 리팩토링

Commit Example

feat: User 로그인 구현

- UserContext 추가
- Login API 추가
- Login 페이지 추가
fix: API 통신 이슈 해결

- 백엔드 Base URL이 잘못 세팅되어 있던 문제 해결