Chore/#199 백엔드 README 개선 - #207
Conversation
WalkthroughREADME.md를 전면 개편했습니다. 프로젝트 개요, 광고 API 통합과 AI 분석 기능, 실행 방법, 스크립트, 프로젝트 구조, CI/CD, 협업 규칙을 상세히 문서화했습니다. ChangesREADME 문서 개편
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
README.md (1)
151-157: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
{domain}예시 트리의 계층을 명확히 하세요.현재 트리는
image/와{domain}/을 같은 수준의 마지막 항목처럼 표시합니다.{domain}/이 실제 디렉터리인지 설명용 템플릿인지 구분하기 어렵습니다.실제 프로젝트 트리와 일반적인 도메인 템플릿을 별도 코드 블록으로 분리하거나,
domains/{domain}/처럼 설명용 경로임을 명확히 표시하세요.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 151 - 157, README의 {domain} 예시 트리를 수정해 설명용 템플릿임을 명확히 표시하세요. 실제 프로젝트 구조와 일반적인 도메인 템플릿을 별도 코드 블록으로 분리하거나, 해당 항목을 domains/{domain}/처럼 템플릿 경로로 표기해 image/와 동일한 실제 디렉터리로 오해되지 않게 하세요.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 99-109: README의 “Run Local Server”와 “Run Full Stack” 절차를 상호 배타적인
실행 모드로 명확히 구분하세요. 호스트에서 애플리케이션을 실행하는 모드에는 애플리케이션 컨테이너를 제외하고 인프라 컨테이너만 시작하는 명령을
안내하고, 전체 스택 모드에는 bootRun을 실행하지 않는다는 점을 명시하세요.
- Line 195: README.md의 배포 명령에서 `docker-compose pull && up -d`를 두 번째 명령에도
`docker-compose`가 포함되도록 수정하세요. `docker image prune -f` 정리 명령과 나머지 설명은 그대로 유지하세요.
- Line 256: README.md의 기여자 이미지 3개에 각각 식별 가능한 alt 속성을 추가하세요. 기존 img 태그의 src와
레이아웃은 유지하고, 각 이미지가 해당 기여자임을 나타내는 대체 텍스트를 사용하세요.
- Line 136: Update the project structure code block in README.md to specify the
text language identifier by changing its opening fence to ```text, while
preserving the existing block contents.
---
Nitpick comments:
In `@README.md`:
- Around line 151-157: README의 {domain} 예시 트리를 수정해 설명용 템플릿임을 명확히 표시하세요. 실제 프로젝트
구조와 일반적인 도메인 템플릿을 별도 코드 블록으로 분리하거나, 해당 항목을 domains/{domain}/처럼 템플릿 경로로 표기해
image/와 동일한 실제 디렉터리로 오해되지 않게 하세요.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 915dbf9e-98f8-4c1a-bf2b-89d5fc374e5a
📒 Files selected for processing (1)
README.md
| ### Run Local Server | ||
|
|
||
| | ||
| ```bash | ||
| ./gradlew bootRun | ||
| ``` | ||
|
|
||
| ### Run Full Stack | ||
|
|
||
| ```bash | ||
| docker-compose up -d | ||
| ``` |
There was a problem hiding this comment.
🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win
로컬 실행과 전체 스택 실행을 분리해 설명하세요.
./gradlew bootRun은 호스트에서 애플리케이션을 실행합니다. 반면 docker-compose up -d는 Line 129에서 App과 인프라를 모두 실행한다고 설명합니다. 두 절차를 함께 따르면 애플리케이션이 중복 실행되어 포트 충돌이 발생할 수 있습니다.
호스트 실행 모드에서는 인프라 컨테이너만 시작하는 방법을 문서화하세요. 전체 스택 모드에서는 bootRun을 실행하지 않는다고 명시하세요.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 99 - 109, README의 “Run Local Server”와 “Run Full
Stack” 절차를 상호 배타적인 실행 모드로 명확히 구분하세요. 호스트에서 애플리케이션을 실행하는 모드에는 애플리케이션 컨테이너를 제외하고
인프라 컨테이너만 시작하는 명령을 안내하고, 전체 스택 모드에는 bootRun을 실행하지 않는다는 점을 명시하세요.
|
|
||
| - **CI** — `.github/workflows/ci.yml`: `main`, `develop` 브랜치에 push / PR 시 MySQL · Redis 서비스 컨테이너를 띄우고 `./gradlew build` 실행 | ||
| - **CD** — `.github/workflows/cd.yml`: `develop` 브랜치 push 시 Docker 이미지 빌드 → Docker Hub 푸시 → Bastion host 경유 EC2 SSH 배포 | ||
| 배포 서버에서는 `docker-compose pull && up -d`로 컨테이너를 교체하고, `docker image prune -f`로 잔여 이미지를 정리합니다. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
배포 명령의 docker-compose 호출을 완성하세요.
docker-compose pull && up -d는 up을 독립적인 셸 명령으로 실행하므로 실패합니다. 두 번째 명령에도 docker-compose를 포함하세요.
수정 예시
-`docker-compose pull && up -d`
+`docker-compose pull && docker-compose up -d`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 배포 서버에서는 `docker-compose pull && up -d`로 컨테이너를 교체하고, `docker image prune -f`로 잔여 이미지를 정리합니다. | |
| 배포 서버에서는 `docker-compose pull && docker-compose up -d`로 컨테이너를 교체하고, `docker image prune -f`로 잔여 이미지를 정리합니다. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 195, README.md의 배포 명령에서 `docker-compose pull && up -d`를 두
번째 명령에도 `docker-compose`가 포함되도록 수정하세요. `docker image prune -f` 정리 명령과 나머지 설명은
그대로 유지하세요.
jinnieusLab
left a comment
jinnieusLab
left a comment
There was a problem hiding this comment.
좋아요~! 저도 필요한 거 생각나면 더 추가할게요!
kingmingyu
left a comment
kingmingyu
left a comment
There was a problem hiding this comment.
P4: 훨씬 깔끔해진 것 같아요! 좋습니다! 저희 개발 끝나면 서버 아키텍처랑 외부 광고 연동 흐름 다이어그램 같은 것도 넣으면 좋을 것 같아요..! 각자 역할이랑!
3 participants
📌 관련 이슈
🚀 개요
WhereYouAd 오거니제이션 전체 대상으로 추가된 README 형식에 맞춰 백엔드 README 형식을 수정합니다.
📄 작업 내용
📸 스크린샷 / 테스트 결과 (선택)
chore/#199 브랜치에서 자세한 내용 확인 가능
✅ 체크리스트
🔍 리뷰 포인트 (Review Points)
Summary by CodeRabbit