Getting Started

개발 서버를 실행하는법

pnpm run dev

Using pnpm

⚠️ 이 프로젝트는 npm이나 yarn대신 pnpm을 사용합니다. pnpm이 설치되어 있지 않다면 아래의 지침을 따라 설치하세요

1. pnpm 설치

npm install -g pnpm

2. 의존성추가

pnpm install

이 명령은 package.json에 정의된 모든 패키지를 설치합니다.

3. 개발 서버 실행

pnpm run dev

이 명령은 앱을 http://localhost:3000에서 실행합니다.

4. Other common pnpm commands

명령어	설명
pnpm install	의존성 설치
pnpm add [pkg]	패키지 추가
pnpm remove [pkg]	패키지 제거
pnpm run [script]	package.json의 스크립트 실행
pnpm update	의존성 업데이트
pnpm install -r	모든 워크스페이스(모노레포) 설치

How to use scss

로컬 SCSS는 .module.scss 파일로 생성해주세요.

styles 폴더 내부 파일들은 전역 스타일을 위한 파일이며, 프로젝트 전체에서 사용할 수 있습니다.

전역적으로 SCSS를 사용하려면 다음과 같이 참조할 수 있습니다: 예시)

.div {
  color: $label-normal;
  font-size: 20px;
  background-color: $background-neutral;
  padding: 16px;
  border-radius: 8px;

  @include mobile {
    font-size: 16px;
    padding: 12px;
  }
}

How to Commit

커밋 타입	설명
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
refactor	코드 리팩토링
test	테스트 코드, 리팩토링 테스트 코드 추가 (프로덕션 코드 변경 X)
design	CSS 등 사용자 UI 디자인 변경
comment	필요한 주석 추가 및 변경
rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove	파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우
chore	단순한 코드 변경

커밋 방법 예시

feat :: 버튼 추가

How to PullRequest

풀 리퀘스트는 반드시 4명의 코드 리뷰어에게 승인받은 후에 진행할 수 있습니다. 풀 리퀘스트