[DOCS/#89] README 작성 및 아키텍처 다이어그램/프로젝트 구조 문서 추가

[lee-si-yeon]

🔗 Related Issue

• Closes [DOCS] README.md 작성 #89

📝 Summary

README 작성 및 아키텍처 다이어그램/프로젝트 구조 문서 추가

🔄 Changes

• API 변경 (추가/수정)
• 데이터 및 도메인 변경 (DB, 비즈니스 로직)
• 설정 또는 인프라 관련 변경
• 리팩토링

💬 Questions & Review Points

• 서버 아키텍처 다이어그램이 실제 인프라 구성(EC2/Nginx/Spring/Redis, RDS Private Subnet)과 일치하는지 확인 부탁드립니다.
• README의 기술 스택/브랜치 전략/프로젝트 구조(DDD) 설명이 과하거나 누락된 부분이 없는지 리뷰 부탁드립니다.

📸 API Test Results (Swagger)

✅ Checklist

• API 테스트 완료
• 테스트 결과 사진 첨부
• 빌드 성공 확인 (./gradlew build)

[gemini-code-assist]

Summary of Changes

Hello @lee-si-yeon, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 PR은 프로젝트의 README.md 파일을 전면적으로 개선하여, 서비스의 목적, 기술 스택, 아키텍처, 개발 프로세스 및 팀 구성에 대한 포괄적인 정보를 제공합니다. 이는 새로운 팀원이나 외부 이해관계자가 프로젝트를 빠르게 이해하고 참여할 수 있도록 돕는 것을 목표로 합니다.

Highlights

• 프로젝트 개요 추가: 서비스의 목적, 주요 기능 (목표 중심 자산 현황 제공, 소비 성향 분석, 금융 상품 추천)을 명확히 설명했습니다.
• 서버 아키텍처 다이어그램 및 구성 요약: 서비스의 서버 아키텍처 다이어그램을 추가하고, Nginx, Spring Boot, Redis, RDS, GitHub Actions를 포함한 주요 구성 요소를 요약했습니다.
• 브랜치 전략 문서화: 이슈 번호를 포함하는 브랜치 명명 규칙과 main, develop, feat, fix, hotfix, ref, docs와 같은 브랜치 타입 예시를 추가했습니다.
• 기술 스택 상세화: 백엔드(Java, Spring Boot, JPA), 데이터베이스/인프라(MySQL, AWS VPC, EC2, Nginx, Docker, Redis), CI/CD(GitHub Actions), 외부 API(CODEF, FSS, Gemini), 협업 도구(GitHub, Swagger) 등 사용된 기술 스택을 상세히 명시했습니다.
• DDD 기반 프로젝트 구조 설명: 도메인 주도 설계(DDD) 관점에서 domain/*과 global/* 디렉토리의 역할을 설명하고, 프로젝트 디렉토리 구조를 시각적으로 표현했습니다.
• 팀원 정보 추가: 각 팀원의 이름, 역할, 담당 업무를 표 형식으로 정리하여 추가했습니다.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • 기존의 간략한 README를 프로젝트 개요, 서버 아키텍처, 브랜치 전략, 기술 스택, DDD 기반 프로젝트 구조, 팀원 정보 등을 포함하는 상세한 문서로 전면 개편했습니다.
  • docs/images/architecture.png 이미지 링크와 docs/project-structure.txt 파일 링크를 추가했습니다.

Activity

• 이슈 #89와 연관되어 있습니다.
• 작성자는 서버 아키텍처 다이어그램이 실제 인프라 구성(EC2/Nginx/Spring/Redis, RDS Private Subnet)과 일치하는지 확인을 요청했습니다.
• README의 기술 스택/브랜치 전략/프로젝트 구조(DDD) 설명이 과하거나 누락된 부분이 없는지에 대한 리뷰를 요청했습니다.
• API 테스트 완료, 테스트 결과 사진 첨부, 빌드 성공 확인(./gradlew build) 체크리스트가 제시되었습니다.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

안녕하세요. README.md 문서화를 위한 수고에 감사드립니다. 전반적으로 프로젝트의 목적, 구조, 기술 스택 등이 매우 명확하고 이해하기 쉽게 작성되었습니다.

요청하신 리뷰 포인트에 대해 확인했습니다:

• 서버 아키텍처: 다이어그램 자체를 볼 수는 없지만, README에 요약된 구성(Nginx, Spring Boot, Redis, RDS 등)은 일반적인 웹 서비스 아키텍처에 부합하며, PR 설명에 언급된 내용과도 일치합니다.
• 문서 내용: 브랜치 전략, 기술 스택, 프로젝트 구조에 대한 설명이 적절하게 잘 기술되어 있습니다. 다만, 기술 스택 부분에서 'GitHub Actions'가 중복으로 기재된 작은 수정 사항을 발견하여 코멘트를 남겼습니다.

전반적으로 훌륭한 문서 업데이트라고 생각합니다. 감사합니다.

[JeongGyul]

깔끔하게 잘 정리해주신거 같아요 수고하셨습니다 👍

제 개인적인 생각으로는 README 상단에 밸류디 로고 이미지나 이런 이미지가 들어가도 좋을듯 싶습니다 🙌