Skip to content

[Docs] #170 - 리꾸 마무리#171

Merged
OneTen19 merged 2 commits intodevelopfrom
docs/#170-readme
Mar 3, 2026
Merged

[Docs] #170 - 리꾸 마무리#171
OneTen19 merged 2 commits intodevelopfrom
docs/#170-readme

Conversation

@OneTen19
Copy link
Copy Markdown
Member

@OneTen19 OneTen19 commented Mar 3, 2026

📟 관련 이슈


Frame (6)

Frame 2087328927

“Neki, 네컷의 순간이 이어지는 곳”

네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스

QR 스캔 한 번으로 앨범에 즉시 저장

흩어져 있던 종이 사진과 디지털 파일을 NEKI 하나로 끝내세요. QR 스캔 한 번으로 앱에서 바로 저장하고, 날짜별/폴더별로 정리됩니다.

QR이 없어도 걱정 NO

예전에 찍어둔 사진이나 QR 유효기간이 지난 사진도 직접 업로드하여 동일하게 관리할 수 있습니다.

"오늘 뭐 하지?" 포즈 고민 해결

카메라 앞에서 당황하지 마세요! NEKI가 제안하는 트렌디한 포즈와 '랜덤 포즈' 기능이 당신의 자연스러운 촬영을 도와드립니다.

원하는 브랜드만 쏙쏙! 완벽한 네컷 지도

지금 바로 찍고 싶을 때, 주변의 사진관을 확인하세요. 브랜드 필터를 사용해 내가 선호하는 브랜드만 골라 찾을 수 있습니다.

추억을 테마별로 관리

친구, 연인, 특별한 기념일 등 목적에 맞춰 폴더를 만들고 소중한 순간들을 테마별로 기록하세요.

Frame (1) Frame (2) Frame (3) Frame (4) Frame (5)

Contributors

윤금용 김한열

Tech Stack

분류 기술 / 도구 역할 버전
IDE & SDK Xcode & SPM Apple의 공식 IDE, Swift 기반 의존성 관리 도구 26.2
UI 프레임워크 SwiftUI 코드의 간결성과 직관성을 통해 빠르고 쉽게 사용자 인터페이스를 설계하고 유지보수가 가능 -
아키텍처 TCA 상태 관리, 단방향 데이터 흐름, 테스트, 사이드 이펙트 처리에 강력하고 일관된 아키텍처 라이브러리 1.23.1
네트워크 계층 URLSession Apple 플랫폼 서버 통신 핵심 네트워킹 API 클래스 -
이미지 처리 Kingfisher 효율적인 이미지 다운로드 및 캐싱을 통해 네트워크 이미지 로딩 성능 향상 8.6.2
비동기 처리 Swift Concurrency 명확하고 안전한 비동기 흐름 관리를 통해 복잡한 비동기 로직의 가동성과 유지보수성 향상 -
로그 관리 Logger 구조화된 로깅을 지원하여 성능 저하 없이 효율적으로 로그 수집 및 분석 가능 -
네컷 지도 NMapsMap 네이버 클라우드 플랫폼에서 제공하는 네이버 지도 SDK 3.23.0
QR 스캐너 AVFoundation 오디오 및 비디오 미디어 데이터를 만들고, 편집, 재생, 기록 및 처리하는 강력한 최상위 프레임워크 -
로그인 KakaoOpenSDK 카카오 소셜 로그인을 통한 간편한 사용자 인증 2.27.1
버전 관리 Git, GitHub 분산 버전 관리 시스템을 통한 형상 관리 및 협업 2.46.0
협업 도구 Figma, Notion UI/UX 디자인 리소스 공유 및 프로젝트 문서화, 태스크 관리 2.46.0
CI/CD Github Actions, Fastlane 번거로운 출시,배포 과정을 자동화 -

Architecture

스크린샷 2026-02-25 오후 7 43 20

Micro Clean Architecture

모듈화와 계층 분리의 결합

기능 단위의 모듈화(Modular)와 내부 3계층 분리(Clean Architecture)를 동시에 적용

4대 핵심 모듈

APP(라우팅), Core(공통 로직/네트워크), Shared(디자인/UI), Features(도메인별 기능)로 역할 분리

Feature 내부 분리

각 도메인 모듈 내부는 Presentation, Domain, Data 계층으로 철저히 분리되어 의존성 최소화

📁 Neki-iOS
├── 📁 APP                  // 앱 진입점 및 최상위 라우팅
   └── 📁 Sources
       ├── 📁 Application
       ├── 📁 MainTab
       └── 📁 Onboarding

├── 📁 Core                 // 공통 비즈니스 로직 및 인프라
   └── 📁 Sources
       ├── 📁 Auth         (Data, Domain, Presentation)
       ├── 📁 Network      (Base, TokenStorage 등)
       ├── 📁 ImagePicker
       └── 📁 Logger

├── 📁 Features             // 도메인별 분리된 기능 모듈 (Micro Clean Architecture)
   ├── 📁 Archive          (아카이브 탭)
      └── 📁 Sources
          ├── 📁 Data
          ├── 📁 Domain
          └── 📁 Presentation
   ├── 📁 Map              (지도 탭)
      └── 📁 Sources
          ├── 📁 Data, Domain, Presentation
   ├── 📁 MyPage           (마이페이지 탭)
      └── 📁 Sources
          ├── 📁 Data, Domain, Presentation
   ├── 📁 Pose             (포즈 추천 탭)
      └── 📁 Sources
          ├── 📁 Data, Domain, Presentation
   └── 📁 QRCodeScanner    (QR 스캐너)
       └── 📁 Sources
           ├── 📁 Data, Domain, Presentation

└── 📁 Shared               // 공통 UI 및 디자인 시스템
    └── 📁 DesignSystem
        ├── 📁 Resources    (Assets, Fonts, Animations)
        └── 📁 Sources
            ├── 📁 Component(Button, Modal, TextField, Toast 등)
            ├── 📁 Modifier
            └── 📁 Color, Font

Convention

Coding

Swift 스타일쉐어 가이드를 기반으로

팀원의 기존 스타일을 반영하였습니다.

Commit

[Feat] : 새로운 기능 구현
[Fix] : 버그, 오류 해결
[Chore] : 코드 수정, 내부 파일 수정, 애매한 것들이나 잡일은 이걸로!
[Add] : 라이브러리 추가, 에셋 추가
[Del] : 쓸모없는 코드 삭제
[Docs] : README나 WIKI 등의 문서 개정
[Refactor] : 전면 수정이 있을 때 사용합니다.
[Setting] : 프로젝트 설정관련이 있을 때 사용합니다.
[Merge] : Pull Develop

예시 [Feat] #1 - 메인 UI 구현


인스타 게시물 시안2

Summary by CodeRabbit

문서

  • README 파일의 이미지 요소 개선 및 정렬
  • 기술 스택 표에 CI/CD 도구 정보 추가

@OneTen19 OneTen19 added this to the 성과공유회 전 작업 milestone Mar 3, 2026
@OneTen19 OneTen19 requested a review from Remaked-Swain March 3, 2026 07:00
@OneTen19 OneTen19 self-assigned this Mar 3, 2026
@OneTen19 OneTen19 added Docs 📑 문서 작성 및 수정 (README.md 등) 한열 🧄 한열 작업 labels Mar 3, 2026
@OneTen19 OneTen19 linked an issue Mar 3, 2026 that may be closed by this pull request
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 3, 2026

Walkthrough

README.md 파일이 업데이트되었습니다. 기존의 큰 이미지 태그를 폭/높이 속성이 있는 다른 이미지 태그로 교체하고, 자리 표시자 댓글 대신 5개의 새로운 프레임 이미지 요소를 추가했으며, Tech Stack 테이블에 CI/CD 행(Github Actions, Fastlane)을 추가했습니다.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
이미지 태그 교체(폭/높이 속성 추가), 5개의 새로운 프레임 이미지 추가, Tech Stack 테이블에 CI/CD 행(Github Actions, Fastlane) 추가

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • Remaked-Swain
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive PR 설명은 상세한 내용을 포함하지만, 제공된 템플릿의 필수 섹션(🌴 작업한 브랜치, ✅ 작업한 내용, ❗️PR Point, 📸 스크린샷)이 구조화되지 않았습니다. PR 템플릿 형식을 따르되, 🌴 작업한 브랜치, ✅ 작업한 내용, ❗️PR Point 섹션을 명시적으로 추가하여 구조화하세요.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed PR 제목 '[Docs] #170 - 리꾸 마무리'는 README 문서를 완성하는 주요 변경사항을 명확하게 요약하고 있습니다.
Linked Issues check ✅ Passed PR 변경사항(README 업데이트, 이미지 추가, 기술 스택 및 아키텍처 문서화)은 이슈 #170 '리드미 마저 꾸미기'의 목표를 충족합니다.
Out of Scope Changes check ✅ Passed 모든 변경사항은 README 문서 완성이라는 범위 내에 있으며, 코드 변경이나 범위를 벗어난 수정사항이 없습니다.
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 docs/#170-readme

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

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: 1

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

1-1: 이미지 태그 문법의 일관성을 고려하세요.

README 내에서 이미지를 삽입하는 방식이 혼재되어 있습니다:

  • Line 1, 20-24: HTML <img> 태그 사용 (width/height 속성 포함)
  • Line 144: 마크다운 문법 ![alt](url) 사용

문서의 일관성을 위해 한 가지 방식으로 통일하는 것을 권장합니다. 프레임 이미지들처럼 크기 제어가 필요한 경우 HTML 태그가 적합하고, 단순 삽입만 필요한 경우 마크다운 문법이 간결합니다.

Also applies to: 20-24, 144-144

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 1, The README mixes HTML <img> tags (with width/height
attributes) and Markdown image syntax (![alt](url)); pick one style and make it
consistent across the file—either convert the HTML <img ... /> occurrences to
Markdown image links if sizing isn't required, or convert the Markdown image at
line 144 to an HTML <img> with explicit width/height to match the frame images;
update all image occurrences so they use the chosen syntax and ensure alt text
and src URLs remain correct.

1-1: 큰 이미지 크기가 페이지 로딩에 영향을 줄 수 있습니다.

모든 프레임 이미지가 1920x1080 크기로 지정되어 있습니다. README 페이지에서는 이보다 작은 크기로 표시하는 것이 일반적이며, 사용자 경험 향상을 위해 적절한 크기 조정을 고려해보세요 (예: width="800" 또는 width="1200").

Also applies to: 20-24

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 1, Large 1920x1080 images in the README slow page load;
find the <img> elements (look for the img tag with
src="https://github.com/user-attachments/...f45abc26-1ea1-470b-845c-ca255b766a83"
and the other similar img tags referenced around the same section) and reduce
their rendered size by either adding a width attribute (e.g., width="800" or
width="1200") or applying a responsive style (e.g., max-width:100%;
height:auto;) so the images display smaller without changing the source files;
apply the same change to the other occurrences mentioned (the additional img
tags around the same README section).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 53: Update the README table row that currently reads "| **CI/CD** |
**Github Actions, Fastlane** | 번거로운 출시,배포 과정을 자동화 | - |" by changing "Github" to
the official "GitHub" casing and inserting a space after the comma in "출시,배포" so
it becomes "출시, 배포"; ensure the cell now reads "| **CI/CD** | **GitHub Actions,
Fastlane** | 번거로운 출시, 배포 과정을 자동화 | - |".

---

Nitpick comments:
In `@README.md`:
- Line 1: The README mixes HTML <img> tags (with width/height attributes) and
Markdown image syntax (![alt](url)); pick one style and make it consistent
across the file—either convert the HTML <img ... /> occurrences to Markdown
image links if sizing isn't required, or convert the Markdown image at line 144
to an HTML <img> with explicit width/height to match the frame images; update
all image occurrences so they use the chosen syntax and ensure alt text and src
URLs remain correct.
- Line 1: Large 1920x1080 images in the README slow page load; find the <img>
elements (look for the img tag with
src="https://github.com/user-attachments/...f45abc26-1ea1-470b-845c-ca255b766a83"
and the other similar img tags referenced around the same section) and reduce
their rendered size by either adding a width attribute (e.g., width="800" or
width="1200") or applying a responsive style (e.g., max-width:100%;
height:auto;) so the images display smaller without changing the source files;
apply the same change to the other occurrences mentioned (the additional img
tags around the same README section).

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 891589b and b67301d.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
| **로그인** | **KakaoOpenSDK** | 카카오 소셜 로그인을 통한 간편한 사용자 인증 | 2.27.1 |
| **버전 관리** | **Git, GitHub** | 분산 버전 관리 시스템을 통한 형상 관리 및 협업 | 2.46.0 |
| **협업 도구** | **Figma, Notion** | UI/UX 디자인 리소스 공유 및 프로젝트 문서화, 태스크 관리 | 2.46.0 |
| **CI/CD** | **Github Actions, Fastlane** | 번거로운 출시,배포 과정을 자동화 | - |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

한국어 띄어쓰기와 대소문자 표기를 수정하세요.

다음 두 가지 사소한 수정이 필요합니다:

  • "출시,배포" → "출시, 배포" (쉼표 뒤 공백 필요)
  • "Github" → "GitHub" (공식 표기법)
✏️ 제안하는 수정
-| **CI/CD** | **Github Actions, Fastlane** | 번거로운 출시,배포 과정을 자동화 | - |
+| **CI/CD** | **GitHub Actions, Fastlane** | 번거로운 출시, 배포 과정을 자동화 | - |
📝 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.

Suggested change
| **CI/CD** | **Github Actions, Fastlane** | 번거로운 출시,배포 과정을 자동화 | - |
| **CI/CD** | **GitHub Actions, Fastlane** | 번거로운 출시, 배포 과정을 자동화 | - |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 53, Update the README table row that currently reads "|
**CI/CD** | **Github Actions, Fastlane** | 번거로운 출시,배포 과정을 자동화 | - |" by changing
"Github" to the official "GitHub" casing and inserting a space after the comma
in "출시,배포" so it becomes "출시, 배포"; ensure the cell now reads "| **CI/CD** |
**GitHub Actions, Fastlane** | 번거로운 출시, 배포 과정을 자동화 | - |".

Copy link
Copy Markdown
Member

@Remaked-Swain Remaked-Swain left a comment

Choose a reason for hiding this comment

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

리꾸

@OneTen19 OneTen19 merged commit 173a9a9 into develop Mar 3, 2026
1 check passed
@OneTen19 OneTen19 deleted the docs/#170-readme branch March 3, 2026 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs 📑 문서 작성 및 수정 (README.md 등) 한열 🧄 한열 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] 리드미 마저 꾸미기

2 participants