happic:

하루 한 컷의 사진과 키워드 분석이 알려주는 나의 행복, 해픽

30th THE SOPT APP JAM
프로젝트 기간 : 2021.07.02 ~ 2021.07.23

Team happic iOS Developers


이세진	윤수빈	강승현
lsj8706	devxsby	ZaidKang

Development Environment and Using Library

Development Environment

Library

라이브러리	사용 목적	Version	Management Tool
Alamofire	서버 통신	5.6.1	SPM
SnapKit	UI Layout	5.0.0	SPM
Then	UI 선언	3.0.0	SPM
Kingfisher	이미지 처리	7.2.4	SPM
Tabman	뷰 페이저 커스텀	2.12.0	SPM
pageboy	뷰 페이저 커스텀	3.6.2	SPM

framework

프레임워크	사용 목적
UIKit	UI 구현

Coding Convention

✨ Git Branch Convention

Branch Naming Rule
- Issue 작성 후 생성되는 번호와 Issue의 간략한 설명 등을 조합하여 Branch 이름 결정
- <Prefix>/<#IssueNumber>-<Description>
Commit Message Rule
- [Prefix] : <Description>
Code Review Rule
- 코드 리뷰는 최대한 빨리 한다.
- 코드 리뷰는 최대한 정성껏 한다.

✨ Git Flow

1. 작업 단위별 Issue 생성 : 담당자, 라벨, 프로젝트 연결 

2. Fork 받은 로컬 레포에서 develop 브랜치 최신화 : git pull (origin develop) 

3. Branch 생성 : git switch -c Prefix/#IssueNumber-description 
  > 예시) chore/#3-Project-Setting

4. 로컬 환경에서 작업 후 Add -> Commit -> Push -> Pull Request의 과정을 거친다.
  
  Prefix의 의미
  > [Feat] : 새로운 기능 구현
  > [Chore] : 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 파일이름 변경
  > [Add] : 코드 변경 없는 단순 파일 추가, 에셋 및 라이브러리 추가
  > [Fix] : 버그, 오류 해결, 코드 수정
  > [Style] : 코드 포맷팅, 코드 변경이 없는 경우, 주석 수정
  > [Docs] : README나 WIKI 등의 문서 개정
  > [Refactor] : 전면 수정이 있을 때 사용합니다
  > [Test] : 테스트 모드, 리펙토링 테스트 코드 추가

5. Pull Request 작성 
  - closed : #IssueNumber로 이슈 연결, 리뷰어 지정

6. Code Review 완료 후 Pull Request 작성자가 develop Branch로 merge하기
  - Develop Branch protection rules : Merge 전 최소 1 Approve 필요

7. 종료된 Issue와 Pull Request의 Label과 Project를 관리

✨ Naming & Code Convention

함수, 메서드 : lowerCamelCase 사용하고, 동사로 시작한다.
변수, 상수 : lowerCamelCase 사용한다.
클래스, 구조체, enum, extension 등 : UpperCamelCase 사용한다.
기본 MVC 폴더링 구조에 따라 파일을 구분하여 사용한다.
파일, 메서드, 클래스 명 약어 사용 지양한다.
- 예시) ViewController → VC (❌)
- 예시) CollectionViewCell → CVC (❌)
- 예시) loginButtonDidTap: UIButton -> loginBtnTapped (❌)
초기 UI 레이아웃 잡아줄때만 configure 키워드를 사용하고, 이외는 set 키워드를 사용한다.
- 예시) func configureUI → func setUI (❌)
- 예시) func setDelegate ... → func configureDelegate (❌)
이외 기본 명명규칙은 Swift Style Guide, API Design Guidelines , Swift Style Guide를 참고한다.
상속받지 않는 클래스는 final 키워드를 붙인다.
단일 정의 내에서만 사용되는 특정 기능 구현은 private 접근 제한자를 적극 사용한다.
퀵헬프기능을 활용한 마크업 문법을 활용한 주석을 적극 사용한다.
이외는 커스텀한 SwiftLint Rule을 적용한다.
- 제외사항
- trailing_whitespace
- identifier_name
- line_length
- type_name

✨ Project Foldering

Happic-iOS
┣ Base.lproj
┃ ┗ Main.storyboard
┣ Global
┃ ┣ Literal
┃ ┣ Base
┃ ┣ Protocols
┃ ┣ Util
┃ ┣ Extension
┃ ┣ Resource
┃ ┃ ┣ Assets.xcassets
┃ ┃ ┃ ┣ AccentColor.colorset
┃ ┃ ┃ ┃ ┗ Contents.json
┃ ┃ ┃ ┣ AppIcon.appiconset
┃ ┃ ┃ ┃ ┗ Contents.json
┃ ┃ ┃ ┗ Contents.json
┃ ┃ ┗ Base.lproj
┃ ┃ ┃ ┗ LaunchScreen.storyboard
┃ ┣ Supports
┃ ┃ ┣ AppDelegate.swift
┃ ┃ ┗ SceneDelegate.swift
┃ ┗ UIComponent
┣ Network
┃ ┣ APIService
┃ ┣ Foundation
┃ ┗ Model
┣ Screens
┃ ┣ Auth
┃ ┣ CreateCharacter
┃ ┣ CreateContents
┃ ┣ HappicCapsule
┃ ┣ HappicReport
┃ ┣ HaruHappic
┃ ┣ Home
┃ ┣ Setting
┃ ┗ Tabbar
┗ Info.plist

Task

대분류	기능	구현 여부	담당자
온보딩	런치스크린		윤수빈
	온보딩	-	윤수빈
회원가입	소셜로그인		윤수빈
	회원가입, 로그인 뷰		강승현
	캐릭터 선택		강승현
홈	캐릭터 뷰		이세진
하루해픽	사진, 태그 뷰		윤수빈
	게시글 작성		윤수빈
	게시글 상세보기		윤수빈
해픽캡슐	캡슐뽑기 뷰		이세진
	푸시 알림		이세진
해픽레포트	전체보기		이세진
	키워드 순위		이세진
	카테고리 순위		이세진
	월 기록 횟수		이세진
설정	설정 뷰		이세진

Be happy, Take a happic:

Comments

[Chore] 해픽 레포트 데이터 전달 로직 수정 (#216)
💥 관련 이슈

closed : #216

💥 구현/변경 사항 및 이유

해픽 레포트의 베스트 해픽 모먼트에서 서버 통신 데이터의 이슈가 발생할 시 앱이 꺼지는 문제 수정을 위해 데이터 전달 로직 수정

💥 PR Point

행복하세요!

💥 참고 사항
세진✨ 📬 API 🐞 BugFix 📌 HappicReport
opened by lsj8706 0
[Chore] Custom Month View 현재 달 수정 (#214)
💥 관련 이슈

closed: #214

💥 구현/변경 사항 및 이유

하루해픽, 해픽레포트에서 사용하는 Custom Month View의 현재 달을 시스템에서 자동으로 받아오도록 수정했습니다.

이외 자잘한 코드 수정

💥 참고 사항

| 하루해픽 사진 뷰 | 하루해픽 태그 뷰 | 해픽레포트 뷰 | | :---: | :---: | :---: | | | | |
🔨 Refactor 수빈✨ 💡Feature
opened by devxsby 0
[Feat] 네트워크 오류시 띄우는 얼럿 뷰 추가 및 홈 컨트롤러 levelProgressView 이슈 (#210)
💥 관련 이슈

closed: #210

💥 구현/변경 사항 및 이유

네트워크 오류시 띄우는 얼럿 뷰 추가 및 뷰 연결

levelProgressView가 제대로 채워지지 않는 이슈 해결

💥 참고 사항

| 얼럿 뷰 예시 | 프로그레스 뷰 이슈 해결 | | :---: | :---: | | | |
세진✨ 📬 API 🔨 Refactor 수빈✨
opened by devxsby 0
[Feat] 소셜 로그인 토큰 UserDefault에 저장 및 기타 수정 (#203)
💥 관련 이슈

closed: #203

💥 구현/변경 사항 및 이유

jwt 토큰을 UserDefault에 저장

자동 로그인 구현

로그인 플로우 수정

캐릭터 변경 기능 추가 (설정 뷰에서)

게시글 삭제 후 하루 해픽 뷰로 돌아가도록 수정

해픽 레포트의 API 호출 시점 viewWillAppear로 수정

💥 PR Point

pull 받고 시뮬에서 앱 삭제했다가 다시 실행해보실래요? 이미 회원가입을 한 카카오 계정이라면 회원가입 대신 로그인 뷰가 보여야합니다.

💥 참고 사항

세진✨ 📬 API 🔨 Refactor 수빈✨ 📌 Auth 💡Feature
opened by lsj8706 0
[Feat] 월 선택 뷰 동기화 및 터치영역 수정 (#184)
💥 관련 이슈

closed: #184

💥 구현/변경 사항 및 이유

월 선택 뷰 동기화

월 선택 뷰 바깥 영역 터치 시 hidden 시키기

💥 PR Point

감사합니다 ...

💥 참고 사항

로딩하는데 시간이 좀 걸려서 인디케이터 바 만들면 좋을 것 같네요,,

📬 API 수빈✨ 📌 HaruHappic
opened by devxsby 0