Skip to content

Commit b4291a7

Browse files
authored
[Merge] #144 - 리꾸 (#153)
* Revise README with enhanced content and visuals Updated README with new images, features, and tech stack details. * Revise README for clarity on NEKI service features Updated the README.md to improve service description and QR scan functionality.
1 parent a8ec0aa commit b4291a7

1 file changed

Lines changed: 106 additions & 43 deletions

File tree

README.md

Lines changed: 106 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,114 @@
1-
<h1 align="center">📸 우리만의 사진 저장소, 네키</h1>
1+
<img width="1920" alt="Frame 2087328876" src="https://github.com/user-attachments/assets/76eab410-423b-4442-ba36-3daead58e4a9" />
22

3-
<img width="2069" height="1479" alt="image 73" src="https://github.com/user-attachments/assets/33c8fdaa-559e-4d0f-a351-ea71cead6868" />
3+
# <img width="200" alt="Frame 2087328927" src="https://github.com/user-attachments/assets/2c0d2cf9-742a-41ad-807a-f2feabcec053" />
44

5+
> “Neki, 네컷의 순간이 이어지는 곳”
56
6-
## Foldering
7+
### 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스
78

8-
```Text
9+
#### <img width="30" height="30" src="https://github.com/user-attachments/assets/7ec36287-820f-4efb-9c46-dc9c85e92263" /> QR 스캔 한 번으로 앨범에 즉시 저장
10+
흩어져 있던 종이 사진과 디지털 파일을 NEKI 하나로 끝내세요. QR 스캔 한 번으로 앱에서 바로 저장하고, 날짜별/폴더별로 정리됩니다.
11+
#### <img width="30" height="30" src="https://github.com/user-attachments/assets/06ab2292-4ab9-4e0a-8332-85508f9ef564" /> QR이 없어도 걱정 NO
12+
예전에 찍어둔 사진이나 QR 유효기간이 지난 사진도 직접 업로드하여 동일하게 관리할 수 있습니다.
13+
#### <img width="30" height="30" src="https://github.com/user-attachments/assets/1dbd5c14-5682-49a0-a826-5da671e13d32" /> "오늘 뭐 하지?" 포즈 고민 해결
14+
카메라 앞에서 당황하지 마세요! NEKI가 제안하는 트렌디한 포즈와 '랜덤 포즈' 기능이 당신의 자연스러운 촬영을 도와드립니다.
15+
#### <img width="30" height="30" src="https://github.com/user-attachments/assets/39297c45-f22a-48a1-a892-ff01c2dddb63" /> 원하는 브랜드만 쏙쏙! 완벽한 네컷 지도
16+
지금 바로 찍고 싶을 때, 주변의 사진관을 확인하세요. 브랜드 필터를 사용해 내가 선호하는 브랜드만 골라 찾을 수 있습니다.
17+
#### <img width="30" height="30" src="https://github.com/user-attachments/assets/ee60a2a4-b933-447f-9a43-df38676b5fe4" /> 추억을 테마별로 관리
18+
친구, 연인, 특별한 기념일 등 목적에 맞춰 폴더를 만들고 소중한 순간들을 테마별로 기록하세요.
919

20+
<!-- 기능 소개 PPT 추가 예정 -->
21+
22+
<br>
23+
24+
## <img width="40" height="40" src="https://github.com/user-attachments/assets/06940c34-fa04-461f-acd6-f6e121ffdd61" /> Contributors
25+
26+
| <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> |
27+
| :--------: | :--------: |
28+
| [윤금용](https://github.com/Remaked-Swain) | [김한열](https://github.com/OneTen19) |
29+
30+
<br>
31+
32+
## <img width="40" height="40" src="https://github.com/user-attachments/assets/06940c34-fa04-461f-acd6-f6e121ffdd61" /> Tech Stack
33+
34+
| 분류 | 기술 / 도구 | 역할 | 버전 |
35+
| --- | --- | --- | --- |
36+
| **IDE & SDK** | **Xcode & SPM** | Apple의 공식 IDE, Swift 기반 의존성 관리 도구 | 26.2 |
37+
| **UI 프레임워크** | **SwiftUI** | 코드의 간결성과 직관성을 통해 빠르고 쉽게 사용자 인터페이스를 설계하고 유지보수가 가능 | - |
38+
| **아키텍처** | **TCA** | 상태 관리, 단방향 데이터 흐름, 테스트, 사이드 이펙트 처리에 강력하고 일관된 아키텍처 라이브러리 | 1.23.1 |
39+
| **네트워크 계층** | **URLSession** | Apple 플랫폼 서버 통신 핵심 네트워킹 API 클래스 | - |
40+
| **이미지 처리** | **Kingfisher** | 효율적인 이미지 다운로드 및 캐싱을 통해 네트워크 이미지 로딩 성능 향상 | 8.6.2 |
41+
| **비동기 처리** | **Swift Concurrency** | 명확하고 안전한 비동기 흐름 관리를 통해 복잡한 비동기 로직의 가동성과 유지보수성 향상 | - |
42+
| **로그 관리** | **Logger** | 구조화된 로깅을 지원하여 성능 저하 없이 효율적으로 로그 수집 및 분석 가능 | - |
43+
| **네컷 지도** | **NMapsMap** | 네이버 클라우드 플랫폼에서 제공하는 네이버 지도 SDK | 3.23.0 |
44+
| **QR 스캐너** | **AVFoundation** | 오디오 및 비디오 미디어 데이터를 만들고, 편집, 재생, 기록 및 처리하는 강력한 최상위 프레임워크 | - |
45+
| **로그인** | **KakaoOpenSDK** | 카카오 소셜 로그인을 통한 간편한 사용자 인증 | 2.27.1 |
46+
| **버전 관리** | **Git, GitHub** | 분산 버전 관리 시스템을 통한 형상 관리 및 협업 | 2.46.0 |
47+
| **협업 도구** | **Figma, Notion** | UI/UX 디자인 리소스 공유 및 프로젝트 문서화, 태스크 관리 | 2.46.0 |
48+
49+
<br>
50+
51+
## <img width="40" height="40" src="https://github.com/user-attachments/assets/06940c34-fa04-461f-acd6-f6e121ffdd61" /> Architecture
52+
53+
<img width="1348" height="596" alt="스크린샷 2026-02-25 오후 7 43 20" src="https://github.com/user-attachments/assets/68188526-4a20-46a1-86bd-e6d5a00c5722" />
54+
55+
### Micro Clean Architecture
56+
57+
#### 모듈화와 계층 분리의 결합
58+
기능 단위의 모듈화(Modular)와 내부 3계층 분리(Clean Architecture)를 동시에 적용
59+
60+
#### 4대 핵심 모듈
61+
APP(라우팅), Core(공통 로직/네트워크), Shared(디자인/UI), Features(도메인별 기능)로 역할 분리
62+
63+
#### Feature 내부 분리
64+
각 도메인 모듈 내부는 Presentation, Domain, Data 계층으로 철저히 분리되어 의존성 최소화
65+
66+
```Swift
1067
📁 Neki-iOS
11-
├── 📁 APP
12-
│   └── 📁 Sources
13-
│   ├── 📁 Application
14-
│   │   └── 📃 Neki_iOSApp.swift
15-
│   └── 📁 Resources
16-
├── 📁 Core
17-
│   └── 📁 Sources
18-
│   ├── 📁 Coordinator
19-
│   │   └── 📁 Sources
20-
│   ├── 📁 Logger
21-
│   │   └── 📁 Sources
22-
│   └── 📁 Network
23-
│   └── 📁 Sources
24-
├── 📁 Features
25-
│   ├── 📁 Archive
26-
│   │   └── 📁 Sources
27-
│   │   ├── 📁 Data
28-
│   │   │   └── 📁 Sources
29-
│   │   ├── 📁 Domain
30-
│   │   │   └── 📁 Sources
31-
│   │   └── 📁 Presentation
32-
│   │   └── 📁 Sources
33-
│   │   └── 📁 Feature
34-
│   │   └── 📁 View
35-
│   └── 📁 Map
36-
│   └── 📁 Sources
37-
│   ├── 📁 Data
38-
│   │   └── 📁 Sources
39-
│   ├── 📁 Domain
40-
│   │   └── 📁 Sources
41-
│   └── 📁 Presentation
42-
│   └── 📁 Sources
43-
│      └── 📁 Feature
44-
│      └── 📁 View
45-
└── 📁 Shared
68+
├── 📁 APP // 앱 진입점 및 최상위 라우팅
69+
└── 📁 Sources
70+
├── 📁 Application
71+
├── 📁 MainTab
72+
└── 📁 Onboarding
73+
74+
├── 📁 Core // 공통 비즈니스 로직 및 인프라
75+
└── 📁 Sources
76+
├── 📁 Auth (Data, Domain, Presentation)
77+
├── 📁 Network (Base, TokenStorage 등)
78+
├── 📁 ImagePicker
79+
└── 📁 Logger
80+
81+
├── 📁 Features // 도메인별 분리된 기능 모듈 (Micro Clean Architecture)
82+
├── 📁 Archive (아카이브 탭)
83+
└── 📁 Sources
84+
├── 📁 Data
85+
├── 📁 Domain
86+
└── 📁 Presentation
87+
├── 📁 Map (지도 탭)
88+
└── 📁 Sources
89+
├── 📁 Data, Domain, Presentation
90+
├── 📁 MyPage (마이페이지 탭)
91+
└── 📁 Sources
92+
├── 📁 Data, Domain, Presentation
93+
├── 📁 Pose (포즈 추천 탭)
94+
└── 📁 Sources
95+
├── 📁 Data, Domain, Presentation
96+
└── 📁 QRCodeScanner (QR 스캐너)
97+
└── 📁 Sources
98+
├── 📁 Data, Domain, Presentation
99+
100+
└── 📁 Shared // 공통 UI 및 디자인 시스템
46101
└── 📁 DesignSystem
47-
├── 📁 Resources
48-
│   └── 📃 Assets.xcassets
102+
├── 📁 Resources (Assets, Fonts, Animations)
49103
└── 📁 Sources
50-
104+
├── 📁 Component(Button, Modal, TextField, Toast 등)
105+
├── 📁 Modifier
106+
└── 📁 Color, Font
51107
```
52108

53-
## Convention
109+
<br>
110+
111+
## <img width="40" height="40" src="https://github.com/user-attachments/assets/06940c34-fa04-461f-acd6-f6e121ffdd61" /> Convention
54112

55113
### Coding
56114

@@ -73,3 +131,8 @@
73131
```
74132

75133
예시 [Feat] #1 - 메인 UI 구현
134+
135+
136+
<br>
137+
138+
<img width="3240" height="400" src="https://github.com/user-attachments/assets/fee4035c-4bac-4921-95ec-93318bd2bdf9" />

0 commit comments

Comments
 (0)