Cuckoo : 빠르고 쉬운 메모, 편한 관리 및 리마인드

  한양대 SS2 전공 프로젝트
  (2023.09.01 - 2023.12.31)

🚀 참여 인원

김경민, 유철민, 장동우, 표지원

🥛 목차

1. 🙋‍♂️ 서비스 소개
2. 🎖️ 핵심 기능
3. 📚 사용 라이브러리
4. 📖 디렉토리 구조
5. 🙏 Git Flow / Rules

---

🙋‍♂️ 서비스 소개

1️⃣ 간편한 메모

타 앱 사용시에도 편하게 공유하기 기능으로 한 곳에 메모 & 링크 모으기

2️⃣ 쉬운 메모 & 링크 관리

태그 기반으로 분류된 모든 메모들을, 사용자에게 맞춘 UI를 통해 관리

3️⃣ 너무 오래된 메모 및 기록을 편하게 관리하도록 리마인드

바쁜 현대인을 위해 기록 조차 까먹은 내용들을 보기 편할때 따로 리마인드 및 알아서 관리!

🎖️ 핵심 스케쥴

Backend Server 구축

• 개발 디렉토리 및 Git Repo 커밋.
• express를 활용하여 API 통신 테스트
• Docker BoilerPlate로 DB와 Sync
• DB 활성화 (설치 및 연동 + migration)
• DB Connect
• API 등록 및 유닛 테스트
• API 연동 테스트
• 기타 등등

화면 구현 (only UI)

• 메모 수정/삭제 UI & View @김경민
  • UI 배치 및 더미 적용
  • 디자인 적용 (~11/22)
• 메모 생성/등록 UI & View @표지원
  • UI 배치 및 더미 적용
  • 디자인 적용 (~11/22)
• 메인 View @장동우
  • UI 배치 및 더미 적용
  • 디자인 적용 (~11/20, 11/22)
• Share extension View @철민 유 (~11/20, 11/22)
  • UI 배치 및 더미 적용
  • 디자인 적용 (~11/20, 11/22)
• 앱 초기 화면 View @표지원 (~11/19 (디자인) → 11/24)
• 설정 페이지 View @철민 유 or @김경민 (~11/19 (디자인) → 11/24)

테스트 (only UI)

• 화면 전체 연결 테스트
• 버튼 및 로직 연결 테스트 (Add Memo, Edit + Share extension 등)

Model & ViewModel - 1 (Data fetch & Logic 초기 구현)

이 시기에 와서 역할 분담 할 예정

• 초기 화면 Model 분리 및 ViewModel 작성 (Logic부분 빼고)
• 홈 화면 Model 분리 &
• 메모 등록 화면 Model 분리 &
  • 상태값 관리 필요
• 메모 수정 화면 Model 분리
  • 상태값 관리 필요

Model & ViewModel - 2 (Data fetch & Logic 구현 완료)

• 초기 화면 진입 정보 다루기 & 기기 서버 등록 Logic
• 홈 화면 Data 띄우는 Logic
• 메모 등록 관련 요청 Logic
• 메모 수정 관련 요청 Logic

통합 테스트 (Full Logic)

• (유저플로우 정의대로) 전체 기능 테스트

📚 사용 라이브러리/툴

🙌 Front-end

🐚 Back-end

📖 디렉토리 구조

|-- Cuckoo (Project)
    |
    |-- Cuckoo_swiftUI
    |       ...
    |       |-- Models
    |       |-- ViewModels
    |       |-- Views
    |
    |-- Sandbox
    |       |-- (추후 추가)
    |
    |
    |-- docs
    |       |-- README
    |       |-- etc..
    |
    |-- ...

🙏 Git Flow / Rules

1️⃣ Commit Convention

• Commit Type만 영어로 작성합니다.

[{commit_목적}] {작업 요약}
(여러줄로 다는 경우) dash로 각 줄별로 수정 내역을 넣기

# example) [add] MainPage layout 추가
# example) [fix] MainPage Header 글자 표기오류 수정

# long example)
[add] MainPage layout 추가
 - UIKit으로 작업
 - //WIP

2️⃣ Branch Convention

(1) master

• 작업한 내용들이 최종적으로 합쳐지는 Branch
• Branch 에 모든 과제/발표자료를 Commit 했을 시, rebase 및 PR 로 Merge

(2) 개인 작업용 Branch

• 기능을 개발해서, 코드 추가/수정 시 브랜치를 생성하고 작업합니다.
• camelCase 준수 요망

{목적}/{작업명_issue}

목적
- add : 과제를 제출하려고 파일을 등록하는 경우
- fix : 잘못 제출했거나, 내용을 보충하기 위해 이미 제출한 내역을 수정하는 경우.

# example : MainPage Layout을 손보고 코드를 추가하는 브랜치의 경우.
-> add/mainPageLayout