README.md

🏡Housing

우리집 관리를 위한 세입자 임대인 소통 서비스

27th ON SOPT Appjam '하우징'

기분 좋은 문의 요청, 부담 없는 문제 해결! 방구석 소통의 시작, 하우징.

프로젝트 기간 2020.12.26 ~ 2021.1.16

🚩 Project Core Value

• 짓다 - 소통의 공간을 짓다
• 잇다 - 자취생과 집주인을 잇다
• 얻다 - 좋은 집주인과 세입자를 얻다

📑Meeting Log

• 20.12.27 1차 회의 ~ 21.01.15 정기 회의

🛠 Tech Stack

Category	What we used
JetPack Components	ViewModel, LiveData, Lifecycle, ViewBinding
Network	OkHttp, Retrofit2
Other Tools	Notion, Slack, Zeplin, Figma

⚡Branching

• Git-flow

  master : 제품으로 출시될 수 있는 브랜치
  develop : 다음 출시 버전을 개발하는 브랜치
  feature : 기능을 개발하는 브랜치
  release : 이번 출시 버전을 준비하는 브랜치
  hotfix : 출시 버전에서 발생한 버그를 수정하는 브랜치
  

• 브랜치명

  • 접두어/담당뷰

    ex) feature/home, feature/home-detail

  • 접두어/기능명

    ex) feature/date-picker, feature/time-picker

🚨Issue Naming

• Labels

  • Android : 공통 작업

  • docs : 문서 작업

  • enhancement : 새로운 기능

  • network : 통신 작업

  • ui : 뷰 작업

• Title

  • [담당뷰] title

    ex) [Home] 소통하기 리스트 추가

🌈Naming Rule

• drawables

  • shapable : border_color_line/fill_[radius]

    ex) border_gray_fill, border_gray_line_16

  • selector : selector_[where]_[description]

    ex) selector_ sign_up_gender_man / selector_ sign_up_gender_woman

  • icon : icon_name

• view

  elementType_where_action ex) btn_home_login

  • btn (Button)
  • img (ImageView)
  • txt (TextView)
  • edt (EditText)
  • vp (ViewPager)
  • rv (RecyclerView)
  • rv_item (RecyclerView Item)
  • tl (TabLayout)

💬Commit Message Convention

• 대문자 TYPE 접두어 사용

• 깃 이슈 번호 붙이기

• [TYPE] #이슈번호 : 내용(한글)

  ex) [FEAT] #1 : 회원가입 추가

📜Libraries

라이브러리	목적
Material-Calendar	아이콘 캘린더 사용
Lottie-for-android	스플래시에 로티 사용
Retrofit2	서버 통신
Gson	서버 통신
StickyScrollView	홈 TabLayout에 적용
kotlinx.coroutines	스플래시

👩‍💻Developer & Role👨‍💻

기능	상세 기능	담당자	구현 여부	통신 구현 여부
스플래시	스플래시	예인	✅	✅
로그인	로그인	가은	✅	✅
회원가입	초대 인증	가은	✅	✅
	회원가입	가은	✅	✅
소통하기	소통하기	명희	✅	✅
	문의 작성	승완	✅	✅
	문의 사진 첨부	승완	✅	✅
	약속 일정 잡기	승완	✅	✅
캘린더	캘린더	예인	✅	✅
	당일 문의/공지사항 목록	예인	✅	✅
우리집 소식	임대인 프로필	가은	✅	✅
	공지사항	가은	✅	✅

🔍핵심 기능 구현 방법 및 코드, 화면

: wiki에 맡은 부분별로 정리되어 있어요 :)

• 스플래시, 캘린더
• 회원가입, 로그인, 우리집 소식
• 소통하기
• 문의 작성, 약속 일정 잡기

🧱Project Structure

📦housing
 ┣ 📂network
 ┣ 📂ui
 ┃ ┣ 📂calender
 ┃ ┣ 📂home
 ┃ ┃ ┣ 📂adapter
 ┃ ┃ ┣ 📂ask
 ┃ ┃ ┣ 📂detail
 ┃ ┃ ┃ ┣ 📂adapter
 ┃ ┃ ┣ 📂viewmodel
 ┃ ┣ 📂join
 ┃ ┣ 📂login
 ┃ ┣ 📂main
 ┃ ┣ 📂notice
 ┃ ┗ 📂splash
 ┣ 📂util
 ┣ 📂utill
 ┗ 📂vo

👩‍👩‍👧‍👦하우드안드

💻 Housing Android Developer

👧 남가은	🧑 양승완	👩 이예인	👩‍🦰 천명희
Android Lead Developer	Android Developer	Android Developer	Android Developer