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

• 프로젝트 이름: ZIPTE 플랫폼 서비스
• 프로젝트 설명: 헥사곤 아키텍쳐 기반 MSA 프로젝트 중 플랫폼 서비스 담당
• 프로젝트 기간 : 2025.03.23 ~ (1인 개발)
• MVP 프로젝트 구경하기

2. Team Member (팀원 소개)

이도연
BE
GitHub

3. Key Features (주요 기능)

• 매물 :

  • 아파트 기반 매물 등록

• 아파트:

  • 아파트의 정보 데이터 받기
  • 좌표 기반 인근 아파트 목록 조회
  • 특정 아파트의 매물 정보 확인 가능

• 관심목록 :

  • 유저별 관심목록(아파트, 지역) 설정 기능

4. Technology Stack (기술 스택)

5. Backend

SpringBoot		3.2.4
MongoDB
Kafka
Docker

6. Cooperation

Git
Notion

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

  src
        ├── main
        │   ├── java
        │   │   └── com
        │   │       └── zipte
        │   │           └── platform
        │   │               ├── PlatformApplication.java
        │   │               ├── core
        │   │               │   ├── config
        │   │               │   │   ├── kafka
        │   │               │   │   └── mongo
        │   │               │   ├── exception
        │   │               │   ├── response
        │   │               │   │   └── pageable
        │   │               │   └── util
        │   │               └── server
        │   │                   ├── adapter
        │   │                   │   ├── in
        │   │                   │   │   └── web
        │   │                   │   │       └── dto
        │   │                   │   └── out
        │   │                   │       ├── jpa
        │   │                   │       │   ├── favorite
        │   │                   │       │   ├── property
        │   │                   │       │   └── user
        │   │                   │       ├── kafka
        │   │                   │       │   └── event
        │   │                   │       └── mongo
        │   │                   │           └── estate
        │   │                   ├── application
        │   │                   │   ├── in
        │   │                   │   │   ├── estate
        │   │                   │   │   ├── favorite
        │   │                   │   │   ├── property
        │   │                   │   │   └── user
        │   │                   │   ├── out
        │   │                   │   │   ├── estate
        │   │                   │   │   ├── favorite
        │   │                   │   │   ├── mq
        │   │                   │   │   ├── property
        │   │                   │   │   └── user
        │   │                   │   └── service
        │   │                   └── domain
        │   │                       ├── BaseDomain.java
        │   │                       ├── estate
        │   │                       ├── favorite
        │   │                       ├── property
        │   │                       └── user
        │   └── resources
        │       ├── application-dev.yml
        │       ├── application-prod.yml
        │       ├── application-test.yml
        │       ├── application.yml
        │       ├── static
        │       └── templates

8. Development Workflow (개발 워크플로우)

브랜치 전략 (Branch Strategy)

우리의 브랜치 전략은 Git Flow를 기반으로 하며, 다음과 같은 브랜치를 사용합니다.

• Main Branch

  • 배포 가능한 상태의 코드를 유지합니다.
  • 모든 배포는 이 브랜치에서 이루어집니다.

• Devlop Branch

  • 만든 기능들이 작동하는지 코드를 합병합니다.

• {feat} Branch

  • 모든 기능 개발은 feat 브랜치에서 이루어집니다.

9. 커밋 컨벤션

type 종류

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
refactor : 코드 리펙토링
test : 테스트 코드, 리펙토링 테스트 코드 추가
chore : 설정 추가

10. ERD