Getting Started (시작하기)

프로젝트 문서
해당 프로젝트의 자세한 문서는 Notion 페이지에 정리되어 있습니다.

yarn install // 의존성 파일 설치 및 빌드 준비
yarn add {패키지명} // 패키지 설치
yarn dev // 로컬 서버 실행

1. Project Overview (프로젝트 개요)

• 프로젝트 이름 : COMING
• 프로젝트 설명 : 반려견 온라인 쇼핑몰 서비스 (Front)

2. Team Members (팀원 및 팀 소개)

김영수	김현정	이지수	조계원
FE / BE	FE	FE	FE / BE
GitHub	GitHub	GitHub	GitHub

3. Key Features (주요 기능)

• 사용자 관리

  1. 회원가입
  2. 로그인
  3. 로그아웃
  4. 카카오 소셜 로그인
  5. 내 정보 수정
  6. 이메일 찾기
  7. 비밀번호 재설정

• 반려견 관련 기능

  1. 반려견 등록
  2. 반려견 수정
  3. 반려견 삭제

• 상품 관련 기능

  1. 상품 카테고리 분류
  2. 상품 등록
  3. 상품 삭제
  4. 반려견 맞춤 상품 추천

• 결제 시스템

  1. 장바구니 상품 등록
  2. 장바구니 상품 삭제
  3. 장바구니 상품 결제 시스템
  4. 결제 정보 등록

4. Tasks & Responsibilities (작업 및 역할 분담)

김영수		장바구니 페이지 개발 결제 내역 페이지 개발 결제 시스템(Toss Payments) API 설계 프론트, 서버, 데이터베이스 배포
김현정		프론트엔드 팀장 공통(Global) 컴포넌트 개발 마이페이지 개발 반려견 등록, 수정 페이지 개발 사용자 정보 수정 페이지 개발
이지수		UI / UX 팀장 메인 페이지 개발 상품 페이지 개발 상품 상세 페이지 개발 검색 페이지 개발
조계원		프로젝트 팀장, 백엔드 팀장 로그인 페이지 개발 이메일 찾기 모달창 개발 비밀번호 재설정 모달창 개발 회원가입 페이지 개발 사용자 관리 API 설계(소셜 로그인, 로그인, 로그아웃, 회원가입, 내 정보 수정, 이메일 찾기, 비밀번호 재설정) 카테고리 관련 API 설계(상위 카테고리 등록, 삭제 / 하위 카테고리 등록, 삭제) 반려견 관련 API 설계(반려견 등록, 수정, 삭제) 상품 관련 API 설계(상품 등록, 수정, 삭제, 조회)

5. Technology Stack (기술 스택)

5.1 Front-End

Javascript
React
Vite
Emotion
Recoil
Vercel

5.2 Back-End

Java
Spring Boot
Gradle
Amazon S3
Amazon RDS
Koyeb

5.3 Cooperation

Git / Github
Notion

6. Project Structure (프로젝트 구조)

// Front-End Project Structure
coming/
├── public/                // 정적 파일 (HTML, 이미지 등)
│   
├── src/                   // 소스 코드 폴더
│   ├── assets/            // 이미지, 폰트 등 정적 자산
│   ├── components/        // 재사용 가능한 UI 컴포넌트
│   ├── apis/              // api 파일
│   ├── utill/             // 커스텀 훅
│   ├── pages/             // 각 페이지별 컴포넌트
│   ├── recoil/            // 상태 관리 (recoil)
│   ├── styled/            // 스타일 초기화 + 전역에서 사용할 색상 정의
│   │          
│   ├── App.jsx           // 메인 리액트 컴포넌트
│   └── main.jsx          // 애플리케이션 진입점
│
├── vite.config.ts         // Vite 설정 파일
├── package.json           // 프로젝트 설정 파일
└── yarn.lock              // 패키지 버전 관리 파일

// Back-End Project Structure
com.coming.pet_store_coming_be
 ├── config           // Spring 및 애플리케이션 설정 관련 클래스
 ├── controller       // 컨트롤러 클래스
 ├── service          // 비즈니스 로직을 담당하는 서비스 클래스
 ├── dao              // 데이터 접근 객체(Data Access Object)
 ├── dto              // 데이터 전송 객체.
 ├── exception        // 예외 처리 클래스. 
 ├── security         // 보안 관련 클래스. 
 ├── util             // 유틸리티 클래스. 
 └── validation       // 입력 값 검증 관련 클래스.