Skip to content

Docs#155/readme#156

Merged
YejinY00n merged 15 commits intodevfrom
docs#155/readme
Jul 7, 2025
Merged

Docs#155/readme#156
YejinY00n merged 15 commits intodevfrom
docs#155/readme

Conversation

@YejinY00n
Copy link
Copy Markdown
Collaborator

@YejinY00n YejinY00n commented Jul 7, 2025

📌 관련 이슈

✨ 기능 요약

항목 내용
🆕 기능명 리드미 추가
🔍 목적 리드미 추가
🛠️ 변경사항 리드미 추가

Summary by CodeRabbit

  • Documentation
    • "니맛내맛" 프로젝트의 주요 기능, 기술 스택, 아키텍처, API 명세, UI 와이어프레임, 배포 및 환경 설정 방법을 포함한 상세 README 파일이 추가되었습니다.
    • 성능 개선, 트러블슈팅, 기술적 의사결정 과정, 팀원 소개 등 다양한 프로젝트 정보가 포함되어 있습니다.

@YejinY00n YejinY00n self-assigned this Jul 7, 2025
@YejinY00n YejinY00n added the Feature 기능 구현 label Jul 7, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 7, 2025

Walkthrough

README.md 파일이 새로 추가되어 "니맛내맛" 프로젝트의 개요, 동기, 주요 기능, 기술 스택, 아키텍처, API 명세, ERD, UI 와이어프레임, 기술적 의사결정, 성능 개선, 트러블슈팅, 팀원 정보 등을 상세히 문서화하였습니다. 코드 변경은 없습니다.

Changes

파일/경로 변경 요약
README.md 프로젝트 소개 및 기술 문서 신규 추가

Assessment against linked issues

Objective (이슈 번호) Addressed Explanation
리드미 문서 작성 (#155)
리드미 이미지 업로드 명시 (#155)

Poem

🍽️
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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Collaborator

@kmchaejin kmchaejin left a comment

Choose a reason for hiding this comment

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

커밋내역 귀엽네요 수고하셨습니다!

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
README.md (3)

41-44: 레포지토리 주소 placeholder 교체

실제 GitHub URL이 비어 있어 복사-실행 시 오류가 발생합니다. 배포 후 README를 참조 자료로 사용하는 외부 기여자를 위해 실제 repo 경로를 기입해 주세요.

-git clone [레포지토리 주소]
+git clone https://github.com/mo00ai/your-my-taste.git

214-241: 여러 이미지 alt 텍스트 누락

아키텍처, ERD, Figma 이미지 모두 동일하게 alt 텍스트가 없습니다.
접근성과 SEO 측면에서 간단한 설명을 추가해 주세요.

-![아키텍쳐](./image/architecture.png)
+![서비스 아키텍처 다이어그램](./image/architecture.png)
...
-![ERD](./image/erd.png)
+![서비스 ERD](./image/erd.png)
...
-![와이어 프레임](./image/figma.png)
+![UI 와이어프레임](./image/figma.png)

174-176: 수평선 구문 통일 추천

*** 대신 표준 마크다운 구분선 --- 사용을 권장합니다. 일부 렌더러(특히 VSCode 플러그인)에서 인식하지 못하는 사례가 있습니다.

-***
+---
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f02566b and 92aa21b.

⛔ Files ignored due to path filters (12)
  • image/ahyun.png is excluded by !**/*.png
  • image/architecture.png is excluded by !**/*.png
  • image/chaejin.png is excluded by !**/*.png
  • image/erd.png is excluded by !**/*.png
  • image/figma.png is excluded by !**/*.png
  • image/jungmin.png is excluded by !**/*.png
  • image/kiha.png is excluded by !**/*.png
  • image/ngrinderTrb1.png is excluded by !**/*.png
  • image/ngrinderTrb2.png is excluded by !**/*.png
  • image/ngrinderTrb3.png is excluded by !**/*.png
  • image/ngrinderTrb4.png is excluded by !**/*.png
  • image/yejin.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

79-79: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


81-81: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


81-81: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


82-82: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


82-82: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


83-83: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


85-85: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


85-85: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


86-86: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


86-86: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


87-87: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


87-87: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


94-94: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


96-96: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


96-96: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


97-97: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


97-97: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


98-98: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


98-98: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


99-99: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


101-101: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


101-101: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


102-102: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


102-102: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


103-103: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


103-103: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


111-111: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


113-113: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


113-113: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


114-114: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


114-114: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


115-115: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


117-117: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


117-117: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


125-125: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


127-127: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


127-127: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


128-128: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


128-128: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


129-129: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


131-131: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


131-131: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


132-132: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


132-132: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


133-133: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


133-133: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


140-140: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


142-142: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


142-142: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


143-143: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


143-143: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


144-144: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


144-144: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


145-145: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


147-147: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


147-147: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


148-148: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


148-148: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


149-149: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


149-149: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


156-156: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


158-158: Images should have alternate text (alt text)

(MD045, no-alt-text)


164-164: Images should have alternate text (alt text)

(MD045, no-alt-text)


170-170: Images should have alternate text (alt text)

(MD045, no-alt-text)


170-170: Images should have alternate text (alt text)

(MD045, no-alt-text)


170-170: Images should have alternate text (alt text)

(MD045, no-alt-text)


172-172: Images should have alternate text (alt text)

(MD045, no-alt-text)


172-172: Images should have alternate text (alt text)

(MD045, no-alt-text)


174-174: Horizontal rule style
Expected: ---; Actual: ***

(MD035, hr-style)


178-178: Images should have alternate text (alt text)

(MD045, no-alt-text)


178-178: Images should have alternate text (alt text)

(MD045, no-alt-text)


178-178: Images should have alternate text (alt text)

(MD045, no-alt-text)


184-184: Images should have alternate text (alt text)

(MD045, no-alt-text)


184-184: Images should have alternate text (alt text)

(MD045, no-alt-text)


190-190: Images should have alternate text (alt text)

(MD045, no-alt-text)


190-190: Images should have alternate text (alt text)

(MD045, no-alt-text)


190-190: Images should have alternate text (alt text)

(MD045, no-alt-text)


190-190: Images should have alternate text (alt text)

(MD045, no-alt-text)


190-190: Images should have alternate text (alt text)

(MD045, no-alt-text)


196-196: Images should have alternate text (alt text)

(MD045, no-alt-text)


196-196: Images should have alternate text (alt text)

(MD045, no-alt-text)


196-196: Images should have alternate text (alt text)

(MD045, no-alt-text)


196-196: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


198-198: Images should have alternate text (alt text)

(MD045, no-alt-text)


204-204: Images should have alternate text (alt text)

(MD045, no-alt-text)


204-204: Images should have alternate text (alt text)

(MD045, no-alt-text)


204-204: Images should have alternate text (alt text)

(MD045, no-alt-text)


210-210: Images should have alternate text (alt text)

(MD045, no-alt-text)


210-210: Images should have alternate text (alt text)

(MD045, no-alt-text)


254-254: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


265-265: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


266-266: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


349-349: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


354-354: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


359-359: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


363-363: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


460-460: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


467-467: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


472-472: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


567-567: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


568-568: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


570-570: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


608-608: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


651-651: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


834-834: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


835-835: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


974-974: Hard tabs
Column: 1

(MD010, no-hard-tabs)


975-975: Hard tabs
Column: 1

(MD010, no-hard-tabs)


976-976: Hard tabs
Column: 1

(MD010, no-hard-tabs)


977-977: Hard tabs
Column: 1

(MD010, no-hard-tabs)


978-978: Hard tabs
Column: 1

(MD010, no-hard-tabs)


979-979: Hard tabs
Column: 1

(MD010, no-hard-tabs)


980-980: Hard tabs
Column: 1

(MD010, no-hard-tabs)


981-981: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1059-1059: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


1204-1204: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


1217-1217: Bare URL used

(MD034, no-bare-urls)


1227-1227: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


1263-1263: Bare URL used

(MD034, no-bare-urls)


1315-1315: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1321-1321: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1337-1337: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1338-1338: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1339-1339: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1340-1340: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1341-1341: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1342-1342: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1347-1347: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1348-1348: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1349-1349: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1350-1350: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1351-1351: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1352-1352: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1353-1353: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1354-1354: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1355-1355: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1385-1385: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1386-1386: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1387-1387: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1396-1396: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1397-1397: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1399-1399: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1400-1400: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1401-1401: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1432-1432: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1433-1433: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1438-1438: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1439-1439: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


1496-1496: Multiple headings with the same content

(MD024, no-duplicate-heading)


1508-1508: Multiple headings with the same content

(MD024, no-duplicate-heading)


1538-1538: Multiple headings with the same content

(MD024, no-duplicate-heading)


1540-1540: Multiple headings with the same content

(MD024, no-duplicate-heading)


1559-1559: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


1610-1610: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


1641-1641: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


1666-1666: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1669-1669: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1672-1672: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1673-1673: Hard tabs
Column: 1

(MD010, no-hard-tabs)


1690-1690: Images should have alternate text (alt text)

(MD045, no-alt-text)


1705-1705: Images should have alternate text (alt text)

(MD045, no-alt-text)


1719-1719: Images should have alternate text (alt text)

(MD045, no-alt-text)


1732-1732: Images should have alternate text (alt text)

(MD045, no-alt-text)


1747-1747: Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: generate-jooq
🔇 Additional comments (1)
README.md (1)

1-1: 이미지에 대체 텍스트(alt) 추가 필요

시각 장애 사용자를 포함한 접근성 확보를 위해 첫 헤더 이미지에도 alt 텍스트를 포함해 주세요.

-![header](https://capsule-render.vercel.app/api?type=speech&color=febc43&height=300&section=header&text=🍽️니맛내맛&fontSize=90&fontColor=ffffff&desc=Your%20My%20Taste!%20%20나만의%20맛집을%20공유하는%20소셜%20맛집%20플랫폼&descSize=22&descColor=bbbbbb&descAlign=47&descAlignY=80)
+![니맛내맛 서비스 헤더](https://capsule-render.vercel.app/api?type=speech&color=febc43&height=300&section=header&text=🍽️니맛내맛&fontSize=90&fontColor=ffffff&desc=Your%20My%20Taste!%20%20나만의%20맛집을%20공유하는%20소셜%20맛집%20플랫폼&descSize=22&descColor=bbbbbb&descAlign=47&descAlignY=80)

@YejinY00n YejinY00n merged commit bcb1c93 into dev Jul 7, 2025
3 checks passed
@YejinY00n YejinY00n deleted the docs#155/readme branch July 7, 2025 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature 기능 구현

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]readme

3 participants