Skip to content

[Refactor] README 전면 개편 및 스크린샷 추가#170

Merged
pooreumjung merged 4 commits into
developfrom
refactor/#169-readme
Jun 1, 2026
Merged

[Refactor] README 전면 개편 및 스크린샷 추가#170
pooreumjung merged 4 commits into
developfrom
refactor/#169-readme

Conversation

@pooreumjung

Copy link
Copy Markdown
Member

🧾 요약

  • 프로젝트 소개, 아키텍처, 기술 스택, 프로젝트 구조, 시작 방법 등을 포함한 README를 전면 개편하고 주요 기능 스크린샷 추가

🔗 이슈

✨ 변경 내용

  • README.md 전면 재작성 — 아키텍처 다이어그램(Mermaid), 기술 스택, 프로젝트 구조, 시작 방법, 개발 규칙 추가
  • assets/screenshots/ 디렉토리 추가 및 주요 기능 스크린샷 6장 포함
  • 구버전 Claude Code 사용 가이드 섹션 제거

✅ 확인

  • 빌드 OK
  • 테스트 OK

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ebfabeae-4525-4de4-8864-72f6321e73f4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/#169-readme

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

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

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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

  • README 전면 개편: 프로젝트 소개, 아키텍처 다이어그램(Mermaid), 기술 스택, 프로젝트 구조, 시작 방법 및 개발 규칙을 포함하여 README.md를 전면 재작성했습니다.
  • 스크린샷 추가: assets/screenshots/ 디렉토리를 신설하고, 정복 지도, 세모피드, 실시간 GPS 트래킹 등 주요 기능에 대한 스크린샷 6장을 추가하여 가독성을 높였습니다.
  • 가이드 정리: 구버전 Claude Code 사용 가이드 섹션을 제거하고, 프로젝트의 최신 개발 환경과 규칙을 명확히 정리했습니다.
New Features

🧠 You can now enable Memory (public preview) 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.

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 the 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 counterproductive. 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.

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.

@pooreumjung pooreumjung self-assigned this Jun 1, 2026
@pooreumjung pooreumjung changed the title [Docs] README 전면 개편 및 스크린샷 추가 [Refactor] README 전면 개편 및 스크린샷 추가 Jun 1, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request comprehensively updates the README.md file, adding detailed sections on the system architecture, API documentation, key features, technology stack, project structure, and local setup instructions. The review feedback points out an inaccuracy in the Mermaid architecture diagram regarding how Prometheus scrapes metrics from the Spring Boot API and provides a corrected diagram suggestion.

Comment thread README.md Outdated
@pooreumjung
pooreumjung merged commit 41920e9 into develop Jun 1, 2026
1 check passed
@howooyeon
howooyeon deleted the refactor/#169-readme branch June 3, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[refactor] README.md 수정

1 participant