Nolmung-client

💡 개요

강아지 동반 가능 시설 공유 플랫폼 ‘놀멍(Nolmung)’은 반려인들이 반려견과 함께 방문할 수 있는 장소를 편리하게 찾아볼 수 있도록 돕습니다.
방문 후에는 ‘오늘멍’을 통해 소중한 추억을 기록하고 되새기며 반려견과의 유대감을 한층 깊게 만들 수 있습니다.
또한, 다른 사용자들과 오늘멍을 나누며 다양한 반려생활의 즐거움을 함께 할 수 있습니다.

🔗 놀멍 바로가기

🔧 기능 소개

1. 회원 등록 및 관리 시스템 : 소셜 로그인 및 회원가입

2. 반려견 정보 관리 시스템 : 프로필 등록, 조회, 수정 및 삭제

3. 장소 검색 시스템 : 지도에서 장소 검색, 키워드로 장소 검색, 장소 검색 필터링

4. 즐겨찾기 시스템 : 즐겨찾기 등록, 조회 및 삭제

5. 다이어리 시스템(오늘멍) : 오늘멍 등록, 조회, 수정 및 삭제

6. 후기 등록 시스템 : 후기 등록, 조회 및 삭제

7. 추천 시스템 : 위치정보 기반 추천, 즐겨찾기 순 추천, 견종별 입장 가능 시설 추천, 개인 맞춤형 추천

⚙️ 기술 스택

🛠️ 시스템 아키텍쳐

📌 ERD

🔗 ERDCloud

🖼️ 와이어프레임

🎯 서버 실행 방법

yarn install
yarn dev

🏛️ 디렉토리 구조

├── src
│   ├── App.tsx
│   ├── Router.tsx
│   ├── assets (이미지, 폰트 등)
│   ├── common (공통으로 사용하는 값들)
│   │   ├── components
│   │   ├── constants
│   │   ├── hooks
│   │   ├── styles
│   │   ├── types
│   │   └── utils
│   ├── main.tsx
│   ├── pages (페이지)
│   │   ├── detail 
│   │   │   ├── components (페이지 내에서 사용할 컴포넌트)
│   │   │   ├── stores (페이지 내에서 사용할 스토어)
│   │   │   ├── hooks (페이지 내에서 사용할 커스텀 훅)
│   │   │   └── index.tsx
│   │   ├── main
│   ├── service (서버와 통신시 필요한 파일)
│   │   ├── apis
│   │   └── googleAnalytics
│   ├── stores (공통으로 사용하는 스토어)
...

📋 Conventions

1. Git 브랜치 전략

Github-Flow
기본적으로 Github Flow를 따라 개발 프로세스를 진행한다.
이는 기능별 브랜치를 생성하고, 코드 리뷰 후 develop 브랜치에 병합하는 방식을 의미한다.

2. 깃 컨벤션

Types

• feat: 새로운 기능
• fix: 버그 수정
• refact: 기능 변경 없이 코드 구조 개선
• docs: 문서 수정 (README 등)
• test: 테스트 코드 추가 또는 수정
• env: 환경 설정 관련
• hotfix: 긴급 수정
• chore: 그 외의 작은 수정들
• deploy: 운영 서버 배포

3. 브랜치 명명 및 커밋 메시지 규칙

• 이슈 생성 후 타입/SV-jira 티켓 넘버 로 브랜치를 생성한다.
  예) feat/SV-1
• 브랜치를 로컬에 받아 개발한다.
• 구현됨에 따라 자주 커밋한다. 한번에 모아서 커밋하지 않는다.
• 커밋 메시지는 지정된 컨벤션에 따른다. 예) feat/SV-1: 버튼 컴포넌트 구현

4. 코드 리뷰 및 PR 관리

• PR을 생성한다. 이때 PR없이 절대 develop 브랜치에 merge하지 않는다.
• 지정된 template을 이용해 구현한다. 이때 PR 제목은 issue와 같은 형식으로 작성한다. 예) feat/SV-1: 버튼 컴포넌트 구현
• PR은 커밋 메시지와 마찬가지로 여러 업무를 모아서 보내지말고 자주 보내 conflict를 줄여야 한다.
• 가능한 팀원은 코드 리뷰를 해주고, 1인 이상 approve하면 본인이 merge하여 메인 브랜치에 푸쉬한다.

🗓️ 추진 일정

🗂️ 최종 산출물

🔗 기획안

🔗 요구사항 정의서

🔗 테이블 정의서

🔗 API 명세서

🔗 WBS

👥 팀원 및 역할 소개

김영수	심여은	이지영	이효린
테크리더 오늘멍 관리 및 기능 구현	지도 장소 검색 및 장소 필터링 구현	소셜로그인 및 온보딩, 마이페이지 구현	장소 상세정보 및 키워드 검색, 장소 추천 페이지 구현