Skip to content

UMC-NECT/Nect-Web

Repository files navigation

🌐 Nect Web

Nect Web 프로젝트의 프론트엔드 레포지토리입니다.


🛠 Tech Stack

Core & Build

React TypeScript Vite

State Management & Data Fetching

Zustand React Query Axios

Styling

Tailwind CSS

Routing & Forms

React Router React Hook Form Zod

DX & Linting

ESLint Prettier Husky


📂 Project Structure

src/
├── api             # API 호출 함수 및 인스턴스
├── assets          # 정적 자산 (이미지, 아이콘, 폰트)
├── components      # 공통 컴포넌트
│   └── layout      # 레이아웃 관련 컴포넌트
├── constants       # 상수 정의 (Enum, 고정값)
├── contexts        # React Context API
├── hooks           # Custom Hooks
├── pages           # 페이지 단위 컴포넌트
├── stores          # Zustand 전역 상태 스토어
├── types           # TypeScript 전역 타입 정의
└── utils           # 공통 유틸리티 함수

📝 Naming Convention (네이밍 규칙)

분류 규칙 예시 비고
변수/함수 camelCase const userInfo, getUserData() 동사로 시작 권장
컴포넌트 PascalCase LoginModal.tsx, UserProfile.tsx 파일명과 컴포넌트명 일치
상수 SCREAMING_SNAKE MAX_COUNT, API_URL const로 선언된 고정값
폴더 kebab-case user-profile, login-page (또는 소문자 사용)
인터페이스 PascalCase IProps, UserType I 접두사 사용 여부 결정

💾 Git & Commit Convention

브랜치 전략

브랜치는 기능과 목적에 따라 다음과 같이 명명합니다

  • feature/이슈번호-기능명 : 새로운 기능 개발
  • fix/이슈번호-버그내용 : 버그 수정
  • refactor/내용 : 코드 리팩토링
타입 설명 예시
feature 새로운 기능 개발 feature/101-login-page
fix 버그 수정 fix/102-typo-correction
refactor 코드 리팩토링 refactor/auth-context-optimization

💬 Commit Message

Conventional Commits 규칙을 따릅니다 태그: 제목

태그 종류

태그 설명
feat 새로운 기능 추가
fix 버그 수정
docs 문서 수정
design UI/CSS 디자인 변경
refactor 코드 리팩토링
chore 빌드 업무 수정, 패키지 매니저 설정 등

예시

feat: 로그인 페이지 구현
fix: API 호출 시 에러 핸들링 추가
refactor: AuthContext 구조 개선

개발 환경 설정

필수 요구사항

  • Node.js 18.x 이상
  • npm 또는 yarn

설치 및 실행

# 의존성 설치
npm install

# 개발 서버 실행
npm run dev

# 린트 실행
npm run lint

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages