Skip to content

comeheredart/ChaRo-iOS

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


์ฐจ๋กœ Charo

์ฐจ์—์„œ์˜ ์˜ค๋Š˜์ด ์ตœ๊ณ ๊ฐ€ ๋  ์ˆ˜ ์žˆ๊ฒŒ, ๋‹น์‹ ์˜ ๋“œ๋ผ์ด๋ธŒ ๋ฉ”์ดํŠธ ์ฐจ๋กœ
๊ฒฝํ—˜ ๊ธฐ๋ฐ˜ ๋“œ๋ผ์ด๋ธŒ ์ฝ”์Šค ๊ณต์œ  ํ”Œ๋žซํผ

SOPT 28th APP JAM
ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ : 2021.06.27 ~ 2021.07.17



Charo iOS Contributors

๐ŸŽ ์žฅํ˜œ๋ น ๐ŸŽ ๋ฐ•์ต๋ฒ” ๐ŸŽ ์ด์ง€์› ๐ŸŽ ์ตœ์ธ์ •
hryeong66 swikkft comeheredart inddoni


Development Environment and Using Library

  • Development Environment

Instagram: Charo_Official

  • Library
๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์‚ฌ์šฉ ๋ชฉ์  Version
Alamofire ์„œ๋ฒ„ ํ†ต์‹  5.4
SnapKit UI Layout 5.0.0
Kingfisher ์ด๋ฏธ์ง€ ์ฒ˜๋ฆฌ 6.0
lottie-ios ์Šคํ”Œ๋ž˜์‹œ, ๋กœ๋”ฉ ์ธ๋””์ผ€์ดํ„ฐ -
  • framework
ํ”„๋ ˆ์ž„์›Œํฌ ์‚ฌ์šฉ ๋ชฉ์ 
UIKit ย 
TmapSDK ๋“œ๋ผ์ด๋ธŒ ๊ฒฝ๋กœ ๊ตฌํ˜„


Our Convention

โšก Git Branch Convention

  • Branch Naming Rule
    • Issue ์ž‘์„ฑ ํ›„ ์ƒ์„ฑ๋˜๋Š” ๋ฒˆํ˜ธ์™€ Issue์˜ ๊ฐ„๋žตํ•œ ์„ค๋ช… ๋“ฑ์„ ์กฐํ•ฉํ•˜์—ฌ Branch ์ด๋ฆ„ ๊ฒฐ์ •
    • <Prefix>/<Issue_Number>-<Description>
  • Commit Message Rule
    • Gitmoji [Prefix] : - <Description>
  • Code Review Rule
    • ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋Š” ์ตœ๋Œ€ํ•œ ๋นจ๋ฆฌ ํ•ด์ฃผ๊ธฐ (24์‹œ๊ฐ„ ๋‚ด๋กœ)

โšก Git Flow

1. Issue ์ƒ์„ฑ : ๋‹ด๋‹น์ž, ๋ผ๋ฒจ(์šฐ์„ ์ˆœ์œ„,๋‹ด๋‹น์ž๋ผ๋ฒจ), ํ”„๋กœ์ ํŠธ ์—ฐ๊ฒฐ 

2. ๋กœ์ปฌ์—์„œ develop ์ตœ์‹ ํ™” : git pull (origin develop) 

3. feature Branch ์ƒ์„ฑโญ๏ธ : git switch -c Prefix/IssueNumber-description 

4. Add - Commit - Push - Pull Request ์˜ ๊ณผ์ •์„ ๊ฑฐ์นœ๋‹ค.
  โš ๏ธ commit template ์‚ฌ์šฉํ•˜์—ฌ ์ด์Šˆ๋ฒˆํ˜ธ์“ฐ๊ธฐ ex. โœ… [CHORE] : #12 - UIstyle ์ ์šฉ
  
5. Pull Request ์ž‘์„ฑ 
closed: #IssueNumber๋กœ ์ด์Šˆ ์—ฐ๊ฒฐ, ํ”„๋กœ์ ํŠธ ์—ฐ๊ฒฐ, ๋ฆฌ๋ทฐ์–ด ์ง€์ •

5. Code Review ์™„๋ฃŒ โ†’ Pull Request ์ž‘์„ฑ์ž๊ฐ€ develop Branch๋กœ merge๐Ÿ’œ

6. ์ข…๋ฃŒ๋œ Issue์™€ Pull Request์˜ Label๊ณผ Project๋ฅผ ๊ด€๋ฆฌ

โšก Naming Convention

  • ํ•จ์ˆ˜ : lowerCamelCase ์‚ฌ์šฉํ•˜๊ณ  ๋™์‚ฌ๋กœ ์‹œ์ž‘
  • ๋ณ€์ˆ˜, ์ƒ์ˆ˜ : lowerCamelCase ์‚ฌ์šฉ
  • ํด๋ž˜์Šค : UpperCamelCase ์‚ฌ์šฉ
  • ํŒŒ์ผ๋ช… (์•ฝ์–ด์‚ฌ์šฉ)
    • ViewController โ†’ VC
    • TableViewCell โ†’ TVC
    • CollectionViewCell โ†’ CVC

โšก Foldering Convention

ChaRo-iOS
 โ”‚
 |โ”€โ”€ Source
 โ”‚   |โ”€โ”€ Extensions
 โ”‚   |โ”€โ”€ ViewModels
 โ”‚   |โ”€โ”€ Models
 โ”‚   |โ”€โ”€ Services
 โ”‚   |โ”€โ”€ Views
 โ”‚   โ”‚   |โ”€โ”€ VCs
 โ”‚   |   |โ”€โ”€ Cells
 โ”‚   |   โ””โ”€โ”€ Components
 โ”‚   โ”‚   โ””โ”€โ”€ Shared
 โ”‚   โ””โ”€โ”€ Supports
 โ”‚       |โ”€โ”€ AppDelegate.swift
 โ”‚       โ””โ”€โ”€ SceneDelegate.swift
 โ””โ”€โ”€ Resource
     |โ”€โ”€ Storyboards
     |โ”€โ”€ Xibs
     |โ”€โ”€ Assets.xcassets
     |โ”€โ”€ LaunchScreen.storyboard
     โ””โ”€โ”€ Info.plist



Service workflow


Task

๋Œ€๋ถ„๋ฅ˜ ๊ธฐ๋Šฅ ๊ตฌํ˜„ ์—ฌ๋ถ€ ๋‹ด๋‹น์ž
์˜จ๋ณด๋”ฉ ์Šคํ”Œ๋ž˜์‹œ -
ย  ์˜จ๋ณด๋”ฉ ์žฅํ˜œ๋ น
ย  ๋กœ๊ทธ์ธ ์ด์ง€์›
๋ฉ”์ธ๋ทฐ ๋ฉ”์ธ๋ฐฐ๋„ˆ ๋ฐ•์ต๋ฒ”
ย  ๋ฉ”์ธ๋ทฐ ์ปจํ…์ธ  ์ด์ง€์›
๊ตฌ๊ฒฝํ•˜๊ธฐ ๊ฒŒ์‹œ๋ฌผ ๋”๋ณด๊ธฐ ๋ฐ•์ต๋ฒ”
ย  ๊ฒŒ์‹œ๋ฌผ ๋”๋ณด๊ธฐ ํ•„ํ„ฐ๋ง ๋ฐ•์ต๋ฒ”, ์ด์ง€์›
ย  ํ…Œ๋งˆ๋ณ„ ๋”๋ณด๊ธฐ ์ด์ง€์›
ย  ๊ฒŒ์‹œ๋ฌผ ์ƒ์„ธ๋ณด๊ธฐ ์ตœ์ธ์ •, ์žฅํ˜œ๋ น
์ž‘์„ฑํ•˜๊ธฐ ๊ฒŒ์‹œ๋ฌผ ์ž‘์„ฑํ•˜๊ธฐ ์ตœ์ธ์ •
ย  ๋“œ๋ผ์ด๋ธŒ ๊ฒฝ๋กœ ์ž‘์„ฑํ•˜๊ธฐ ์žฅํ˜œ๋ น
ย  ๊ฒฝ๋กœ ์ตœ๊ทผ ๊ฒ€์ƒ‰ ๋ชฉ๋ก ์žฅํ˜œ๋ น
๊ฒ€์ƒ‰ํ•˜๊ธฐ ๋งž์ถค ๊ฒ€์ƒ‰ ์žฅํ˜œ๋ น
ย  ๊ฒ€์ƒ‰ ๊ฒฐ๊ณผ ๋ฆฌ์ŠคํŠธ ๋ฐ•์ต๋ฒ”
ย  ๊ฒ€์ƒ‰ ๊ฒฐ๊ณผ ๋ฆฌ์ŠคํŠธ ํ•„ํ„ฐ๋ง ๋ฐ•์ต๋ฒ”


App Description

์•ฑ ์ฃผ์š” ๊ธฐ๋Šฅ ์„ค๋ช… Comming Soon!



About

๐Ÿš™ ํ‚น~ ๐Ÿš™

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 60.7%
  • Objective-C 39.3%