README.md

💛 YELLO-iOS

📃 프로젝트 설명

투표로 관계의 재미를 찾아가는 서비스, YELL:O

🛫 TEST FLIGHT

https://testflight.apple.com/join/9xqm0VQa

🍎 iOS Developers

👑 정채은	변희주	이지희
chaentopia	Heyjooo	Zoe0929
추천친구, 내 옐로, 프로필	투표 (옐로하기)	온보딩
아 옐로💛를 위해 코드짜고 있었는데 미치겠다	히주가 ??? 개발하고 싶대 답 : 옐로 💛	행복한 노란색 개발자 💛

📚 Library

1. Alamofire
    - 서버 통신을 위한 관련 라이브러리
    
2. KakaoOpenSDK
    - 카카오 소셜 로그인을 위한 라이브러리

3. KingFisher
    - 서버 통신의 이미지를 가져오기 위한 라이브러리
    
4. Lottie
    - 애니메이션 효과를 가진 뷰를 구현하기 위한 라이브러리
    
5. SnapKit
    - Code base 개발을 원활하게 도와주는 라이브러리

6. SwiftKeychainWrapper
    - Keychain을 관리해주는 라이브러리

7. Then
    - Code base 개발을 원활하게 도와주는 라이브러리

💻 Code Convention

YELL:O iOS 코드 컨벤션

⛓️ Git Convention & Git Flow 전략

YELL:O iOS 깃 컨벤션

1. 내가 구현할 기능이 생겼다면 ?? 일단 이슈를 판다 -> TodoList 작성하자 !
2. 만든 Issue에 해당하는 작업을 수행할 Feat 브랜치를 만든다 (ex: feat/#<이슈번호>)
3. 열심히 작업한다음 Add - Commit - Push를 한다 ! 그러면 remote에 내가 작업한 내용이 올라가겠죠 !
4. main 브랜치로 Pull Request를 날린다 : main브랜치랑 비교해서 내 브랜치에 생긴 변경사항을 봐주세요 ~ 이런느낌이라고 생각하면 되겠죠 ?? 
5. Pull Request가 작성되면 작성자 이외의 다른 팀원이 Code Review를 한다 !!
6. Code Review가 완료되면 내가 작업하던 브랜치에 이어서 수정작업을 거친다. 
7. 수정작업한 것을 push 하면 pull request 밑에 추가됨 !! 
8. Approve를 받은 다음, main branch를 pull 받는다.
	- 왜 ?? pull request 날린 이후에 내가 코드리뷰 반영하고 이것저것 수정하는 동안 누군가 머지를 해서 main이 바꼈을 수도 있기 때문 !! 
	- 안전하게 가장 최신의 main을 가져오기 위해 pull을 해주는겁니당 !! : conflict 해결
9. Pull Request 작성자가 main Branch로 merge ! 끝.. !
**릴리즈 관리를 위해서 develop 브랜치와 main 브랜치를 분리합니다.**

🎁 Project Foldering Convention

📦 YELLO-iOS
┣ 📜 .swiftlint
┣ 📂 Storyboard
┃ ┣ 📜 LaunchScreen
┃
┣ 📂 Application
┃ ┣ 📜 Appdelegate
┃ ┣ 📜 SceneDelegate
┃
┣ 📂 Global
┃ ┣ 📂 Extension
┃ ┣ 📂 Literals
┃ ┃ ┣ 📜 Image
┃ ┃ ┣ 📜 String
┃ ┣ 📂 Resources
┃ ┃ ┣ 📂 Font
┃ ┃ ┣ 📜 Font
┃ ┃ ┣ 📜 Color
┃ ┃ ┣ 📜 Assets
┃ ┃ ┣ 📜 Info.plist
┃ ┣ 📂 Protocols
┃
┣ 📂 Presentation
┃ ┣ 📂 Base
┃ ┣ 📂 Splash
┃ ┣ 📂 Onboarding
┃ ┃ ┃ ┣ 📂 ViewController
┃ ┃ ┃ ┣ 📂 Views
┃ ┃ ┃ ┣ 📂 Cells
┃ ┣ 📂 Tabbar
┃ ┣ 📂 Inviting
┃ ┣ 📂 Voting
┃ ┣ 📂 Recommending
┃ ┣ 📂 Around
┃ ┣ 📂 MyYello
┃ ┣ 📂 Profile
┃
┣ 📂 Network
┃ ┣ 📂 Base
┃ ┣ 📂 Onboarding
┃ ┃ ┃ ┣ 📂 DTO
┃ ┃ ┃ ┃ ┣ 📂 Request
┃ ┃ ┃ ┃ ┣ 📂 Response
┃ ┃ ┃ ┣ 📂 Router
┃ ┃ ┃ ┣ 📂 Service
┃ ┣ 📂 Recommending
┃ ┣ 📂 Voting
┃ ┣ 📂 MyYello
┃ ┣ 📂 Profile

📱 뷰 및 기능 설명

🎐 정채은

이름	스크린샷	설명
추천친구		친구추가를 할 수 있도록 카톡 친구와 학교 친구를 확인할 수 있는 화면입니다. Segment Control를 이용해 카톡 친구와 학교 친구를 구분하였습니다. 카톡 친구 부분에서는 온보딩 과정에서 카카오톡 친구 연결을 통해 받아온 데이터로 카카오톡 친구 중 옐로에 가입한 사람이 뜹니다. 학교 친구에서는 유저와 동일한 학과의 친구들이 뜹니다. 서버 통신으로 테이블뷰에 들어갈 값을 배열에 넣어 로드해주었습니다. 무한 스크롤을 위해서 테이블뷰 바닥에 닿았을 때 서버 통신에서 page 수를 하나씩 증가시켜 배열에 추가해주었습니다. 최신화 시키기 위해서 UIRefreshControl을 이용해 새로고침이 가능하도록 했습니다. 친구가 없을 때는 친구 초대 alert view를 볼 수 있는 버튼이 생깁니다. 분기 처리를 통해서 해당 버튼이 있는 셀이 보입니다.
둘러보기		친구가 받은 쪽지를 볼 수 있는 화면입니다. 2차 스프린트에서 구현할 화면입니다.
내 쪽지		내가 받은 쪽지를 볼 수 있는 화면입니다. 쪽지 확인 유무와 힌트 사용 유무에 따라서 다르게 보입니다. UITableView에 Cell을 3개 register하여 힌트 사용 유무에 따라 다른 셀이 사용되도록 처리하였습니다. 내 쪽지도 마찬가지로 무한 스크롤을 구현하였고, 쪽지가 없을 때는 쪽지가 없다는 뷰가 셀에 생겨납니다. UIRefreshControl로 새로고침이 가능합니다. 셀을 선택하면 해당하는 쪽지를 확인할 수 있습니다. 포인트를 이용해 키워드를 확인할 수 있고, 키워드를 확인하면 포인트를 써서 보낸 사람의 초성을 확인할 수 있습니다. 보낸 사람의 초성은 서버에서 보여줄 초성의 이름 인덱스를 보내주고, 이름을 초성으로 바꾸어주었습니다. 보낸 사람을 확인하려면 결제 안내 화면으로 넘어갑니다. 인스타그램 공유하기 버튼을 누르면 화면이 캡쳐되어 인스타그램 스토리로 공유됩니다.
내 프로필		내 정보와 내 친구들을 확인할 수 있는 화면입니다. 그룹 추가 버튼을 누르면 그룹을 추가할 수 있는 구글폼으로 이동합니다. 내 친구들의 정보를 바텀 시트로 확인할 수 있고, 친구 끊기도 가능합니다. 내 친구들도 UITableView와 무한 스크롤, UIRefreshControl 을 적용했습니다. 모두 스크롤이 가능하도록 상단의 내 프로필과 내 친구들 총 명수가 적힌 부분은 테이블뷰의 Header로 설정했습니다. 관리 버튼을 누르면 고객센터, 개인정보 처리방침, 이용약관이 있고 각각 외부 링크로 연결됩니다. 로그아웃을 하면 로그아웃과 동시에 로그인 초기 화면으로 돌아갑니다. 회원 탈퇴 버튼을 누르면 회원 탈퇴에 대한 정보를 볼 수 있고 탈퇴가 가능합니다.

🐰 이지희

이름	스크린샷	설명
Splash		DispatchQeue를 이용해서 스플래쉬가 2.3초 재생 후에 로그인 화면으로 이동하도록 구현했습니다. 로고 부분의 애니메이션은 Lottie 파일을 이용해서 한번만 재생되도록 설정했습니다. ( 참고: SceneDelegate.swift)
카카오로그인		카카오 로그인 API를 이용해서 소셜 로그인을 구현했습니다. 카카오톡 설치 여부를 확인해서 카카오톡이 설치되어있지 않다면 카카오 계정으로 로그인하도록 분기처리를 했습니다. 소셜 로그인에 성공한다면 카카오톡 유저의 정보를 자체 API를 통해 서버에 전달합니다. UserDefault를 이용해서 로그인 여부를 저장하여 자동로그인을 구현합니다.
카카오 친구 연결		�카카오 소셜 API를 연결하여 User의 친구 정보를 전달받아 자체 서버로 전송합니다. (현재 카카오에서 API 이용 관련 인가를 해주지 않아서 Team Member만 친구 연결이 가능합니다.)
학교 입력		학교 정보를 입력합니다. UITextFieldDelegate를 이용해서 텍스트 필드에 입력(focusing)이 감지되면 새로운 모달뷰를 띄워 학교 검색을 진행합니다. 현재 학교가 추가되어 있지 않다면 helperButton을 통해 구글 폼으로 연결됩니다. 학교 검색을 하는 새로운 모달뷰에서는 TextField에 addTarget을 통해 textFieldDidChange을 연결합니다. 이 때 이벤트는 'editingChanged'를 감지시켜서 변화하는 값을 실시간으로 사용할 수 있도록 구현했습니다. 이를 이용해서 입력에 대한 실시간 검색을 진행합니다. 학과 검색에 대한 결과는 테이블뷰로 표시되며 한 페이지당 10개씩 전달을 받아 무한 스크롤을 구현했습니다. 자세한 구현 사항은 트러블슈팅에 기록하였습니다. 그 후 테이블 셀을 선택하면 tableViewDelegate를 이용해서 선택한 셀에 대한 정보를 저장하고 delegate에 의해 이전뷰에 정보가 전달됩니다.텍스트 필드에 값이 입력되게 되면 custom TextField인 YelloTextField의 상태가 변화하게 되고 변화된 UI가 적용됩니다.
학과, 학번 정보 입력		학과 검색은 학교 검색과 같은 뷰와 기능을 가지고 있습니다. 따라서 BaseSearchViewController를 이용해서 컴포넌트와 기능 구현을 재사용하도록 작성했습니다. 학과 검색 뷰에서 해당하는 학과를 선택하면 tableViewDelegate를 이용해서 선택한 셀에 대한 정보를 저장하고 delegate에 의해 이전뷰에 정보가 전달됩니다. 이 때는 그룹에 대한 아이디가 함께 전달되어 추후 학교 친구를 찾을 때 사용하게 됩니다. 학번에 대한 정보를 저장할 때는 iOS 16 이상의 기기에서는 sheetPresentationController을 이용해서 하프 모달 뷰를 present하도록 구현했고 그 이하의 기기에서는 커스텀된 하프 모달뷰를 사용했습니다.
�이름, 아이디 입력 부분		이름과 아이디를 입력합니다. 정규식을 통해 이름은 한글만 입력할 수 있도록, 아이디는 소문자와 숫자,온점(.), 밑줄(_)만 입력이 가능하도록 제한했습니다. UITextFieldDelegate를 이용해서 텍스트필드의 입력이 끝났음을 감지하고 이외의 입력이 입력되었을 때는 TextField의 UI를 업데이트합니다. 서버 통신을 통해 아이디 중복성을 검사하여 아이디가 중복될 경우에는 에러 UI를 업데이트합니다.
카톡 친구 추가		카카오 소셜 연결로 가져온 친구 목록 중 옐로에 가입한 친구들만 보이도록 API를 이용해서 검색하고 테이블 뷰를 이용해서 사용자에게 보여줍니다. 이때, 학교검색과 학과 검색에 사용한 무한 스크롤 방식을 이용해서 무한 스크롤을 구현했습니다.
추천인 코드		추천인 코드를 입력하는 뷰입니다. 이전에 사용했던 ID 중복성 API를 이용해서 추천인 코드에 해당하는 ID가 존재하는지에 대해 검색하고 존재하는 아이디가 아닌 경우에는 에러 TextField UI로 업데이트합니다. 건너뛰기를 하게 되면 추천인 코드에는 빈 문장(””)아 입력되게 됩니다.
온보딩 완료 뷰		온보딩 완료 안내 화면입니다. Lottie를 이용해서 애니메이션을 구현하였습니다. 이전에 입력한 정보들은 User라는 싱글톤 객체에 저장이 되어 옐로하러가기 버튼을 클릭 시 서버에 POST로 전송됩니다.

🍀 변희주

이름	스크린샷	설명
투표잠금		친구 수가 4명 미만인 경우 시작화면에 띄워지는 화면입니다. 친구 초대하기 버튼을 누르면 팝업창이 띄워지고, 팝업창에는 내 추천인코드와 카카오톡으로 친구를 초대할 수 있는 버튼, 친구에게 보낼 수 있는 메세지가 담겨있는 링크를 복사할 수 있는 버튼이 있습니다. viewWillAppear에서 서버통신을 하여 투표가능여부를 받아오고 만약 친구를 추가해서 친구 수가 4명 이상이 되었다면 투표시작 or 타이머 화면으로 넘어갑니다.
투표시작		친구 수가 4명 이상이고 타이머 시간이 다 지났을 때 시작화면에 띄워지는 화면입니다. 화면 중앙 이미지는 로티 애니메이션을 사용하여 구현하였습니다. viewWillAppear에서 서버통신을 하여 투표가능여부, 투표할 질문정보 배열 10개를 받아옵니다. viewDidLoad에서 서버통신을 하여 현재 포인트를 받아와 화면에 띄웁니다. 시작하기 버튼을 누르면 질문지를 전달하며 투표뷰컨으로 push됩니다.
투표		1부터 10까지의 투표지를 보여주는 화면입니다. 10개의 각 화면은 배경색, 말풍선, 표정이 모두 다르고 다음화면으로 push될 때마다 매번 새로운 값을 적용했습니다. 각 화면은 안에 내용만 바뀌는 형식이라 push횟수를 저장하는 저장프로퍼티 하나를 선언해놓고 뷰컨 하나를 재사용하며 push횟수를 증가시키는 방식으로 구현했습니다. 친구셔플 버튼을 누르면 서버통신을 하여 친구를 셔플시키고, 이 질문 건너뛰기 버튼을 누르면 질문을 건너뛸 수 있습니다. 한 번 이름 버튼을 누르면 셔플, 건너뛰기 버튼은 disable 처리가 되고 다시 눌러서 취소하기가 불가능합니다. 만약 취소하려고 다시 이름버튼을 누르면 토스트메세지가 뜨며 셔플, 건너뛰기 버튼을 눌러도 마찬가지로 토스트메세지가 뜹니다. 또한 한 번 키워드 버튼을 누르면 취소할 수 없고 셔플 버튼은 누를 수 있으나 건너뛰기 버튼은 누를 수 없습니다. 만약 클릭할 시 토스트메세지가 뜹니다. 이름, 키워드를 선택할 때마다 첫째줄, 둘째줄이 채워지며 건너뛰기를 하지 않은 모든 답변이 구조체 배열 형태로 저장됩니다. 10번째 투표가 종료되면 저장된 구조체 배열을 전달하며 포인트적립 화면으로 push됩니다.
포인트적립		투표를 끝내고 나서 몇 포인트가 적립되었는지 알려주는 화면입니다. 모든 투표지에는 랜덤으로 포인트가 지정되어있고 10개의 질문지 중 투표한 질문지에 해당하는 포인트를 모두 더해서 총합 몇포인트가 적립되었는지 보여줍니다. 또한 적립된 포인트와 원래 포인트를 더해서 현재 포인트가 얼마인지도 보여줍니다. 확인 버튼을 누르면 서버에 지금까지 투표한 내용이 담긴 구조체 배열을 POST하며 타이머 뷰컨으로 push됩니다. 만약 확인버튼을 누르지 않고 앱을 종료시켜버린다면 투표의 내용은 저장되지 않습니다.
타이머		투표를 시작하기 위해 몇분이 남았는지 보여주는 화면입니다. viewWillAppear에서 서버통신을 하여 투표를 POST한 시간을 받아온 다음 현재시간과 비교하여 40분중 몇 분이 남았는지 확인하고 보여줍니다. 만약 40분이 다 지난다면 투표시작화면으로 이동하고, 지나지 않았다면 시작화면을 타이머 화면으로 고정합니다. 기다리지 않고 바로 투표하기 버튼을 누르면 팝업창이 띄워지고, 팝업창에는 내 추천인코드와 카카오톡으로 친구를 초대할 수 있는 버튼, 친구에게 보낼 수 있는 메세지가 담겨있는 링크를 복사할 수 있는 버튼이 있습니다. 만약 친구가 나의 추천인 코드를 기입하고 가입을 한다면 타이머 40분이 바로 해제되어 투표를 시작할 수 있게 구현했습니다.

🌠 Trouble Shooting

프로젝트를 진행하며 어려웠던 점에 대해 트러블 슈팅을 작성했습니다. 

YELL:O iOS 트러블 슈팅

📸 합숙 중 사진