📋 목차

• 📖 프로젝트 소개
• 🎯 프로젝트 목표
• 🛠️ 기술 스택
• 🚀 Quick Start
• 🌿 Git Branch 전략
• 📝 Commit Message Convention
• 📚 상세 문서

📖 프로젝트 소개

핵심 차별점:

• 🎯 메뉴 인증 시스템: GPS 기반 100m 반경 내 메뉴 인증
• ☕ 커피 원두 정보: 생산 국가, 농장, 품종, 가공 방식 등 상세 정보
• 📝 테이스팅 노트: 초심자/심화자 템플릿으로 체계적인 커피 기록
• 🧪 커핑 노트: SCA 표준 7가지 항목 평가 (Fragrance, Aroma, Flavor 등)
• 📊 커피 여권: 국가별, 로스터리별 통계 및 방문 기록
• 🤖 AI 추천: 취향 기반 원두/메뉴 추천 (Vector Search + LLM)
• 📌 북마크: 폴더 기반 카페 저장 및 관리

🎯 프로젝트 목표

핵심 가치

• 접근성: 커피 초보자부터 심화자까지 수준별 기록 템플릿 제공
• 탐험: 지도 기반으로 새로운 카페를 발견하고 메뉴 인증
• 개인화: AI 기반 취향 분석 및 맞춤 추천
• 기록: 테이스팅 노트를 통한 체계적인 커피 기록 관리

타겟 사용자

• 스페셜티 커피에 관심 있는 20-30대
• 새로운 카페를 탐험하고 싶은 커피 애호가
• 체계적으로 커피를 기록하고 싶은 사용자
• 자신의 커피 취향을 찾아가고 싶은 초보자

🛠️ 기술 스택

Backend (이 레포지토리)

Frontend (별도 레포지토리)

Infrastructure

🚀 Quick Start

요구 사항

• Java 21+
• MySQL 8.0+
• Redis Stack Server (벡터 검색 지원)

실행 방법

# 1. Redis Stack Server 실행
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest

# 2. 프로젝트 클론
git clone https://github.com/S14-Comeet/Comeet-Backend.git
cd Comeet-Backend

# 3. 환경 변수 설정 (application-local.yml 참고)

# 4. 빌드 (테스트 제외)
./gradlew clean build -x test

# 5. 실행
./gradlew bootRun

데이터베이스 초기화

SQL 파일은 아래 순서대로 실행합니다:

# 1. 스키마 생성
mysql -u [user] -p [database] < src/main/resources/sql/schema/schema.sql

# 2. 스키마 변경사항 적용 (필요시)
mysql -u [user] -p [database] < src/main/resources/sql/schema/change.sql

# 3. 기초 데이터 입력
mysql -u [user] -p [database] < src/main/resources/sql/data/flavor_prod.sql
mysql -u [user] -p [database] < src/main/resources/sql/data/country_coordinates.sql

# 4. 메인 데이터 임포트
mysql -u [user] -p [database] < src/main/resources/sql/data/data_import.sql

# 5. 데이터 정규화
mysql -u [user] -p [database] < src/main/resources/sql/data/normalize_bean_country_and_processing.sql

API 문서

서버 실행 후 Swagger UI에서 API 문서를 확인할 수 있습니다:

• Local: http://localhost:8080/

🌿 Git Branch 전략

GitHub Flow

- master: 프로덕션 배포 브랜치
- feature/#issue: 기능 개발 브랜치 (예: feature/1, feature/2)

워크플로우

1. 기능 개발: feature/#issue 브랜치에서 작업
2. 완료 후: master 브랜치로 직접 Merge Request
3. 코드 리뷰: MR 승인 후 머지
4. 배포: master 브랜치 자동 배포

📝 Commit Message Convention

기본 형식 (Angular Commit Convention)

[gitmoji] type(#issue): subject

[optional body]

[optional footer]

Type

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 포맷팅, 세미콜론 누락 등 (코드 변경 없음)
• refactor: 코드 리팩토링
• test: 테스트 코드 추가/수정
• chore: 빌드, 패키지 매니저 설정 등
• perf: 성능 개선
• ci: CI/CD 설정 변경
• build: 빌드 시스템 변경

Scope (필수)

• #이슈번호 형식으로 작성
• 예: #1, #42, #123

Subject (필수)

• 50자 이내로 간결하게 작성
• 마침표 없이 명령문으로 작성
• 한글 또는 영문 사용 가능

Gitmoji (선택)

• 커밋 타입을 시각적으로 표현
• 사용 여부는 선택 사항

자주 사용하는 Gitmoji

📚 상세 문서

프로젝트의 상세한 설계 및 구현 가이드는 다음 문서를 참고하세요:

• Comeet_기능명세서.xlsx - 상세 기능 명세