6조 Promeet

📂 프로젝트 소개

🔑 대학생들의 약속 조율을 돕는 사이트입니다.

 

🔧 기술 스택

Type	Tool
Bundler
Library
Language
Styling
Formatting
Package Manager
Version Control
Deployment
Collaboration

 

🔩 프로젝트 설정 및 실행 방법

1. 프로젝트 클론하기

먼저, Git 저장소에서 프로젝트를 로컬로 클론해야 합니다. 터미널(또는 명령 프롬프트)을 열고 아래 명령어를 입력합니다.

git clone https://github.com/Global-Media-Web-Programming/Promeet.git

해당 명령어는 지정된 Git 저장소에서 프로젝트를 로컬 컴퓨터로 복사해옵니다.

2. 의존성 설치

프로젝트가 로컬에 클론된 후, 프로젝트 폴더로 이동한 다음, 필요한 패키지들을 설치해야 합니다. Node.js 기반 프로젝트인 경우, npm 명령어를 사용하여 의존성을 설치할 수 있습니다.

npm install

이 명령어는 package.json 파일에 정의된 모든 의존성(dependencies)을 자동으로 설치해 줍니다.

3. 개발 서버 실행

모든 의존성이 설치되면, 개발 서버를 실행하여 프로젝트를 로컬에서 테스트할 수 있습니다.

npm run dev

이 명령어를 통해 개발 모드에서 서버를 시작하며, 변경 사항이 있을 때 자동으로 갱신됩니다. 이후, 브라우저에서 http://localhost:5173 주소로 접속하여 애플리케이션을 확인할 수 있습니다.

 

📄 폴더 구조

 

📌 우리의 컨벤션

네이밍 컨벤션

• 폴더명: kebab-case → e.g. navigation-bar, server-actions

• 파일명:

  • 기본 파일: camelCase → e.g. calculate.ts, apiClient.ts
  • 컴포넌트 파일: PascalCase → e.g. Button.tsx, ProductList.tsx

• 변수 및 함수

  • 함수명: camelCase → e.g. fetchProducts(), handleSubmit()

  • 변수명: camelCase → e.g. userName, itemCount

  • 상수명: UPPER_SNAKE_CASE

  • 화살표 함수

    • 컴포넌트: 하단에 default export

      const ProductList = () => {
        return <div>상품 리스트</div>;
      };

    • 여러 가지 함수: 각 함수를 named export

      export const fetchItems = () => {
        /* ... */
      };
      export const updateUser = () => {
        /* ... */
      };

  • 컴포넌트 컴포넌트명: PascalCase → e.g. Header, LoginForm 페이지 컴포넌트: Page 접미사 사용 → e.g. MainPage, CartPage

커밋 컨벤션

e.g. style: 홈페이지 스타일링

• feat: 새로운 기능 추가
• style: css 수정 및 코드의 의미에 영향을 미치지 않는 변경사항
• fix: 버그 수정
• refactor: 리팩토링, 기능 변화 없이 코드 구조 개선
• chore: 코드 수정 외 잡다한 작업 (빌드 과정이나 설정 변경 등)
• docs: 문서 변경
• test: 테스트 코드 추가 또는 수정
• rename: 파일, 폴더, 변수 등 이름 변경
• remove: 파일, 폴더, 변수 등 삭제
• comment: 주석 추가, 삭제, 수정

정해진 규칙에 따라 자동적으로 코드 스타일을 정리해 코드의 일관성을 유지하고자 했습니다.
코드 품질 관리는 eslint로, 코드 포맷팅은 prettier로, 스타일 코드 포맷팅은 stylelint로, 커밋 메시지 관리는 commitlint로 했습니다. 팀원들과 소통하여 코딩 컨벤션을 구축했습니다.
그리고 husky를 사용해 규칙에 맞지 않으면 커밋을 제한했습니다.

브랜치 전략

main, develop 브랜치와 feat 보조 브랜치를 사용했습니다.

• main: 배포 가능한 안정적인 상태의 코드를 유지
• develop: 기능 개발이 완료된 코드가 머지되는 브랜치
• feat: 기능 단위로 독립적인 개발 환경을 위하여 사용하고 merge 후 각 브랜치를 삭제 / issue 하나 당-branch 하나, PR 하나
  • feat 브랜치 이름 규칙: feat/기능명-이슈번호 e.g. feat/admin-login-12

 

🕓 프로젝트 진행 과정

 

💁 구성원

🍀 홍준우	🍀 김여진	🍀 박민지	🍀 장태빈
역할:	역할:	역할:	역할: