README.md

Photoravel | 사진관광 플랫폼

TourAPI 및 공공데이터를 활용한 충청남도 사진관광 웹애플리케이션 서비스

백엔드 파트의 주요 개발 목표

• 사용자 위치기반 장소 탐색 서비스 개발
• 다수의 이미지 데이터 관리 시스템 개발
• 로컬 또는 소셜(카카오)계정 인증 시스템 개발
• 사진작가와 일반 회원간의 매칭 시스템 개발

백엔드 배포 아키텍처

백엔드 서버 아키텍처

DB ERD

주요 기능

담당 업무

• Location/Spot/Review 도메인 개발 담당 (CRUD)
• 이미지 데이터 관리 시스템 개발
  • 이미지 데이터 관리환경 분리 (개발/운영환경)
  • 개발환경은 MinIO / 운영환경은 AWS S3로 분리하되, 동일한 AWS SDK 코드로 동작하도록 구성

시퀀스 다이어그램

이미지 저장

S3에는 이미지 데이터, DB에는 S3 이미지 저장위치를 관리하도록 구성

• 사용자 위치기반 장소 탐색 서비스 개발
  • 탐색 범위 내에 위치하는 모든 장소 탐색 (경도/위도 기반)
  • Hibernate-Spatial을 구현한 MySQLSpatialDialect를 이용하여 개발

기술 스택

Java 17	MySQL	Docker	Hibernate-Spatial
Spring boot 3	Junit5	AWS (EC2, RDS, S3)	AWS (Cloudfront)
Spring Data JPA	Git	Jenkins	MinIO
QueryDSL	Swagger
Spring Security

프로젝트 기간

2024.05. ~ 2024.10.

팀구성

황제연	성현석	신동욱
hwangjeyeon	Seong57	DongUk-Shin

협업 방법

프론트엔드 개발자와 협업 방법

• Swagger로 REST API 문서화

백엔드 개발자간 협업 방법

Github Wiki

• 협업 간, 이해를 돕기위해 Github Wiki를 작성하였습니다.
  • MinIO 사용방법 및 사용목적

Code Review Culture

• 코드 리뷰문화를 정착하여, 32번의 PR에서 296번의 코드리뷰를 작성했습니다

Git Convention

• Main 브랜치는 Prototype 테스트 통과 이후 merge한다
• 모든 pull Request는 자신을 제외한 다른 두 팀원의 Code Review를 받은 후 수락한다

Commit Message Convention

Tag	Description
Feat	새로운 기능 추가
Fix	단순 버그 수정
Style	코드 포맷 변경, 세미콜론 누락, 필요없는 패키지 제거 등
!HOTFIX	치명적인 버그 수정
Refactor	코드 리팩토링
Comment	주석 추가 및 수정, 삭제
Test	테스트 코드 추가 / 변경
Chore	빌드 도구(Gradle) 추가/수정
Rename	파일,폴더명 수정
Remove	파일 삭제
Config	설정 파일 수정
Move	파일 위치 변경
Docs	문서 수정(README.MD 등)

Example

Feat: location CRUD 컨트롤러 기능 구현 **<-- Head (머릿말)**
<br> 1번 컨트롤러는 Create,DELETE 2번 컨트롤러는 READ, UPDATE를 담당합니다. **<-- Body (본문)**

Code Convention

• 변수명 camelCase 준수
• 들여쓰기 탭 사용
• 한줄 최대 글자수 100자 제한