Revise README for UNITY Backend Server details

[joonhyong]

Key Changes

• README 추가입니다.

작업 내역

• close:

💬 공유사항 to 리뷰어

• 다들 너무 수고많으셨고, 이후 프로젝트도 화이팅입니다. 😊

비고

Summary by CodeRabbit

• 문서화
  • 프로젝트 README를 종합적으로 업데이트했습니다
  • 기술 스택, 인증 구조, 데이터베이스 설정 정보 추가
  • 로컬 환경에서 서버를 실행하는 방법 안내 추가
  • 에러 응답 정책 및 API 문서 참고 방법 명확화
  • 프로젝트 폴더 구조 및 인증 흐름 상세 설명

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

프로젝트 README를 "Ureca-server"에서 "UNITY Backend Server"로 재명명하고 내용을 대폭 확장했습니다. Java 17, Spring Boot 3.x, MySQL 8.x 등 기술 스택을 명시했으며, OAuth2(Google/Kakao/Naver) 및 JWT 기반 인증 흐름을 구체화했습니다. Refresh Token Rotation 정책, 에러 응답 형식, 데이터베이스 스키마, 폴더 계층 구조, 로컬 실행 방법을 신규 추가하여 개발자 온보딩 가이드를 완성했습니다.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

---

📝 코치 피드백

좋은 점:
README 확장이 체계적이고 명확합니다. 기술 스택부터 실행 방법까지 새 개발자가 필요한 정보를 한눈에 파악할 수 있네요.

개선 제안:

1. 인증 흐름 다이어그램 추가
   텍스트로만 설명된 OAuth → JWT 변환 과정은 시퀀스 다이어그램으로 시각화하면 이해도가 올라갑니다. Mermaid를 활용해보세요.

2. 환경 변수 설정 가이드 구체화
   profiles, database settings만 언급되어 있는데, 실제 .env 예시나 application.yml 샘플을 제시하면 설정 오류를 줄일 수 있습니다.

3. API 문서 링크 명확히
   Swagger UI 참조가 있지만, 정확한 URL 패턴(예: http://localhost:8080/swagger-ui.html)을 제시하세요.

4. 에러 코드 테이블 추가
   CustomException과 ErrorCode 예시는 좋으나, 실제 운영되는 에러 코드 목록을 별도 문서로 링크하면 더 실용적입니다.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	제목이 README 수정이라는 실제 변경 내용을 명확히 반영하고 있으며, UNITY Backend Server 세부 사항 문서화라는 주요 목적을 잘 나타냅니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch joonhyong-patch-1

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}