[CHORE] #1 project base and spring javaformat

.coderabbit.yaml

@@ -0,0 +1,54 @@
+# ---------------------------------------------------------------- #
+# CodeRabbit AI 설정
+# ---------------------------------------------------------------- #
+
+# 응답 기본 언어 설정
+language: "ko-KR"
+
+# AI 페르소나 및 톤앤매너 지시
+tone_instructions: >
+  1. 피드백은 명확하고 구체적이어야 하며, 문제의 원인과 개선 방법을 반드시 제시하세요.
+  2. 리뷰는 교육적이어야 하며, 관련 개념이나 공식 문서를 함께 추천하세요.
+  3. 비판보다는 개선 중심의 제안을 우선하세요.
+  4. 칭찬은 짧고 위트 있게 작성하세요.
+
+# ---------------------------------------------------------------- #
+# 코드 리뷰 기능 세부 설정
+# ---------------------------------------------------------------- #
+reviews:
+  profile: "chill"                  # 리뷰 전반 스타일 (부드러운 톤)
+  request_changes_workflow: false   # 코멘트 resolve 시 자동 Approve 처리
+  high_level_summary: true          # PR 변경 사항 고수준 요약 활성화
+  collapse_walkthrough: true        # 워크스루 코멘트 접기 활성화
+  changed_files_summary: true       # 변경된 파일별 요약 생성
+  sequence_diagrams: true           # 실행 흐름 시퀀스 다이어그램 생성
+  assess_linked_issues: true        # 연결된 이슈 분석 컨텍스트 활용
+  related_issues: false             # 연관 다른 이슈 링크 비활성화
+  related_prs: true                 # 연관 다른 PR 링크 활성화
+  suggested_labels: false           # 적절한 레이블 제안 비활성화
+  auto_apply_labels: false          # 제안 레이블 자동 적용 비활성화
+  suggested_reviewers: false        # 동료 리뷰어 추천 비활성화
+  auto_assign_reviewers: false      # 추천 리뷰어 자동 할당 비활성화
+  poem: true                        # 리뷰 요약에 위트 있는 시 포함 활성화
+
+  # ---------------------------------------------------------------- #
+  # 자동 리뷰 트리거 설정
+  # ---------------------------------------------------------------- #
+  auto_review:
+    enabled: true
+    auto_incremental_review: true   # 추가 커밋 시 변경된 부분만 자동 리뷰
+
+# ---------------------------------------------------------------- #
+# 채팅 기능 설정
+# ---------------------------------------------------------------- #
+chat:
+  auto_reply: true                  # 태그하지 않아도 자동 답글 활성화
+
+# ---------------------------------------------------------------- #
+# CodeRabbit의 지식 기반(Knowledge Base) 설정
+# ---------------------------------------------------------------- #
+knowledge_base:
+  web_search:
+    enabled: true                   # 최신 문서 검색 허용
+  code_guidelines:
+    enabled: true

.gitattributes

@@ -0,0 +1,10 @@
+# Git이 알아서 OS에 맞게 줄바꿈을 변환해 주도록 강제
+* text=auto
+
+# 윈도우 배치 파일은 무조건 CRLF로 고정
+*.bat text eol=crlf
+*.cmd text eol=crlf
+
+# 리눅스/맥용 셸 스크립트는 무조건 LF로 고정
+gradlew text eol=lf
+*.sh text eol=lf

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## 📍 개요
+<!-- 어떤 주제인지 요약 -->
+> 소셜 로그인 구현
+
+### ⛓️‍💥 관련 이슈
+<!-- 관련 이슈 번호 -->
+- Closes #이슈번호
+
+---
+### 🛠️ 작업 내용
+<!-- 무엇을 변경했는지 핵심 내용 요약 -->
+- 소셜 로그인 API 추가
+
+---
+### 🔥 리뷰 요청 사항
+> 리뷰어가 중점적으로 확인해주었으면 하는 내용을 작성해주세요.
+
+- 예외 코드 처리 방식
+
+---
+### ✅ 체크리스트
+
+* [ ] 코드 컨벤션을 준수했습니다.
+* [ ] 불필요한 코드 및 import를 제거했습니다.
+* [ ] 예외 처리를 적용했습니다.
+* [ ] 테스트를 완료했습니다.
+* [ ] 관련 Issue를 연결했습니다.
+
+---
+### 📎 참고 사항

.gitignore

@@ -0,0 +1,53 @@
+# ================================================================= #
+# Git ignore for Spring Boot / Java / Gradle / IntelliJ (Muse Review)
+# ================================================================= #
+
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/resources/gradle/wrapper/gradle-wrapper.jar
+!**/src/test/resources/gradle/wrapper/gradle-wrapper.jar
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Operating System ###
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# 암호키 및 보안 인증서 관련 파일
+*.key
+*.pem
+*.jks
+
+
+MR_config/*
+
+MR_config/local/*
+
+!MR_config/local/application.example.yml

MR_config/local/application.example.yml

@@ -0,0 +1,42 @@
+# ================================================================= #
+# 🔒 [NOTICE] 본 파일은 로컬 환경 세팅용 '공통 예시 파일'입니다.
+# 각자 로컬 PC 사양에 맞게 정보를 입력한 후, 파일 이름을
+# 'application.yml'로 변경하여 동일한 경로에 위치시켜 주세요!
+# ================================================================= #
+
+spring:
+  # 1. 로컬 데이터베이스 커넥션 설정 (PostgreSQL 18)
+  datasource:
+    driver-class-name: org.postgresql.Driver
+    url: jdbc:postgresql://localhost:5432/mr_db # [체크] 로컬에 mr_db 빈 데이터베이스를 먼저 생성
+    username: postgres                          # [입력] PostgreSQL 계정명
+    password: ""                                # [입력] PostgreSQL 비밀번호 (빈값 입력 가능)
+
+  # 2. JPA 및 하이버네이트 구동 설정
+  jpa:
+    hibernate:
+      ddl-auto: update # 엔티티 매핑 정보 변경 시 DB 테이블 자동 반영
+    show-sql: true     # 콘솔에 실행 SQL 포맷 출력
+    properties:
+      hibernate:
+        format_sql: true
+        dialect: org.hibernate.dialect.PostgreSQLDialect
+
+# 3. Spring Security 및 JWT 인증 설정
+jwt:
+  # [입력] HS256 알고리즘을 충족하는 256비트(32바이트) 이상의 임의의 비밀키를 채워주세요.
+  # 기입 예시: "your-local-custom-secret-key-must-be-very-long-and-secure-32bytes"
+  secret: ""
+  access-token-validity-in-seconds: 1800     # Access Token 만료 시간 (30분)
+  refresh-token-validity-in-seconds: 604800  # Refresh Token 만료 시간 (7일)
+
+# 4. 외부 소셜 로그인 API 연동 정보 (OAuth용)
+oauth:
+  kakao:
+    client-id: ""     # [입력] 카카오 디벨로퍼스 REST API 키
+    client-secret: "" # [입력] 카카오 보안 Client Secret 키
+    redirect-uri: http://localhost:8080/login/oauth2/code/kakao
+  google:
+    client-id: ""     # [입력] 구글 클라우드 콘솔 OAuth 클라이언트 ID
+    client-secret: "" # [입력] 구글 클라우드 콘솔 보안 비밀번호
+    redirect-uri: http://localhost:8080/login/oauth2/code/google

README.md

@@ -0,0 +1,71 @@
+# 🎵 Muse Review - Backend
+
+> **뮤즈리뷰 백엔드 개발 팀 공통 컨벤션 및 가이드북입니다.** > 모든 팀원은 원활한 협업을 위해 아래 규칙을 반드시 준수해 주세요!
+
+---
+
+## 🌿 1. 브랜치 전략 (Git Flow)
+
+우리 팀은 안정적인 배포와 독립적인 기능 개발을 위해 브랜치를 분리하여 관리합니다.
+
+* 🔵 **`main`** : 항상 배포 가능한 상태를 유지하는 운영 브랜치 (직접 작업 금지, PR 머지만 허용)
+* 🟢 **`develop`** : 다음 배포를 준비하는 통합 개발 브랜치 (모든 기능 개발본이 모이는 곳)
+* 🟡 **`기능 브랜치`** : 기능/이슈 단위로 `develop`에서 파생하여 개발하는 브랜치
+
+### 📌 Branch Naming Convention
+* **구조:** `Prefix/#이슈번호-작업내용` (Kebab Case 사용)
+* **예시:** `feat/#10-login-api`, `chore/#1-setting-base`
+
+| Prefix | 설명 | 사용 예시 |
+| :--- | :--- | :--- |
+| `feat` | 새로운 기능 추가 | `feat/#10-login-api` |
+| `fix` | 버그 수정 | `fix/#23-header-layout` |
+| `docs` | 문서 수정 (README 등) | `docs/#5-update-readme` |
+| `style` | 코드 포맷팅 (로직 변경 없음) | `style/#12-format-code` |
+| `refactor`| 코드 리팩토링 | `refactor/#30-user-service` |
+| `chore` | 설정 파일 변경, 패키지 빌드 등 | `chore/#1-setting-base` |
+
+---
+
+## 📝 2. 커밋 컨벤션 (Commit Convention)
+
+* **메시지 구조:** `타입: 작업 내용 (#이슈번호)` 형식으로 작성 (제목은 50자 이내 소문자 태그 권장)
+* **예시:** `feat: 카카오 소셜 로그인 API 추가 (#10)`
+
+### 🔓 PR 머지 및 코드 리뷰 규칙
+* **PR 머지 조건:** 활발한 코드 리뷰를 위해 **최소 2명 이상의 승인(Approve)**이 있어야 머지 가능
+* **리뷰 태그 가이드:**
+    * `P1`: 꼭 반영해 주세요 (중대한 오류 가능성, Request Changes 필수)
+    * `P2`: 적극적으로 고려해 주세요 (토큰/논의 권장)
+    * `P3`: 웬만하면 반영해 주세요 / 가벼운 의견 (Comment 처리)
+
+---
+
+## 🛠️ 3. 개발 환경 및 코드 컨벤션
+
+### 💻 Tech Stack
+* **Language & Framework:** Java 17 / Spring Boot 3.2.2
+* **Database:** PostgreSQL 18 / JPA
+
+### 🎨 Code Style (Spring JavaFormat)
+우리 프로젝트는 `Spring JavaFormat` 플러그인을 사용하여 공통 포맷을 강제합니다. 빌드 시 포맷이 맞지 않으면 컴파일이 실패할 수 있습니다.
+* **클래스명:** `PascalCase` (`class AuthController`)
+* **변수/메서드명:** `camelCase` (`String accessToken`)
+* **상수명:** `UPPER_SNAKE_CASE` (`int MAX_LIMIT = 3`)
+* ⚠️ **주의:** 변수 및 메서드명에 언더바(`_`) 사용을 금지합니다.
+
+---
+
+## 🔒 4. 로컬 환경 세팅 (민감 정보 보호)
+
+민감 정보(DB 패스워드, JWT Secret, OAuth Key) 유출 방지를 위해 `MR_config` 안전 금고 시스템을 사용합니다.
+
+1. 로컬 PostgreSQL에 `mr_db` 데이터베이스를 생성합니다.
+2. 프로젝트 루트에 `MR_config/local/` 폴더를 생성합니다.
+3. 공유된 `application.example.yml` 파일을 해당 폴더에 복사한 뒤, 파일명을 **`application.yml`**로 변경합니다.
+4. 본인의 로컬 DB 비밀번호와 개인 API Key를 입력한 후 서버를 구동합니다.
+
+### 🚀 로컬 빌드 명령어
+* **Windows PowerShell:** `./gradlew.bat build -x test`
+* **Git Bash / Mac:** `./gradlew build -x test`
+* **Swagger UI 주소:** `http://localhost:8080/swagger-ui/index.html`

build.gradle

@@ -0,0 +1,76 @@
+plugins {
+    id 'java'
+    id 'org.springframework.boot' version '3.2.2'
+    id 'io.spring.dependency-management' version '1.1.7'
+    // formater
+    id 'io.spring.javaformat' version '0.0.41'
+}
+
+group = 'com.mr'
+version = '0.0.1-SNAPSHOT'
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
+configurations {
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+
+    // Swagger
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'
+
+    // JWT
+    implementation 'org.springframework.boot:spring-boot-starter-security'
+    implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
+    runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
+    runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
+
+    // PostgreSQL 18, JPA
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    runtimeOnly 'org.postgresql:postgresql'
+
+    // Lombok   , DevTools
+    compileOnly 'org.projectlombok:lombok'
+    annotationProcessor 'org.projectlombok:lombok'
+    developmentOnly 'org.springframework.boot:spring-boot-devtools'
+
+    // Health Check
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
+
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+}
+
+test {
+    useJUnitPlatform()
+}
+
+// Private Config Copy
+tasks.register('copyPrivateConfig', Copy) {
+    def envDir = file('./MR_config/local')
+
+    if (!envDir.exists()) {
+        envDir.mkdirs()
+        file('./MR_config/local/application.yml').text = "# 이 경로에 복사한 로컬 설정을 채워 넣어 주세요!"
+    }
+
+    from './MR_config/local'
+    into 'src/main/resources'
+}
+
+tasks.named('processResources') {
+    dependsOn 'copyPrivateConfig'
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists