See Docs

문서를 볼 수 있는 Android App

Design

Figma

화면 구성

• Home: 디바이스의 문서 파일 목록을 보여줍니다.
• Bookmark: 북마크된 파일들이 모여있는 목록.
• PdfView: PDF 화면
• TextView: Text 화면
• ImageView: Image 화면

프로젝트 목표

• PDF 이미지, 텍스트 등을 볼 수 있는 서비스 구현

Download

Releases - CI/CD를 통한 배포

Tech stack & Open-source libraries

• Minimum SKD level 26
• Kotlin based, 비동기 작업 Coroutines + Flow
• Jetpack Libraries:
  • Jetpack compose: Android UI toolkit
  • ViewModel: UI 관련 데이터를 관리하고 수명 주기를 인식하여 구성이 변경되어도 데이터 생존 보장
  • Hilt: 종속성 주입
• Architecture:
  • MVI Architecture (Model-View-Intent)
  • Clean Architecture
• Kotlin Serialization
• Koin
• Ksp
• Room

Architecture

MVI 패턴과 CleanArchitecture를 기반으로 구성

UI Layer

MVI 패턴으로 구성

상태는 아래로 이벤트는 위로 이동하는 단방향 데이터흐름으로 구현

• Intent: 사용자의 입력 이벤트를 캡처하고, 이를 Model에게 전달할 Action이나 Event로 변환.
• Model: 상태 변화를 처리하고, View가 구독하여 화면을 갱신.
• View: 상태(Model)를 기반으로 UI를 렌더링. 사용자의 입력 이벤트를 Intent로 변환해 전달.

모듈화 전략

• 재사용성: 재사용 가능한 코드를 모듈화하여, 코드를 공유하고 동시에 다른 모듈에서 코드의 접근성 제한
• 병렬 빌드: 각 모듈을 병렬로 실행할 수 있어 빌드 시간 단축
• Decentralized focusing: 각 기능 별 모듈을 나누어 자체 모듈에 집중해서 작업.

프로젝트 중점 사항

• Contents Provider를 통한 디바이스 파일 접근
• 단위 테스트 작성
• PDF 뷰어 기능
• 텍스트 뷰어 기능 및 이미지 뷰어 기능
• PDF 및 텍스트 파일 내에서 키워드 검색 기능 구현 및 검색어 하이라이트 표시
• GitHub Action을 이용한 테스트, 빌드 CI 구현 및 Git Releases APK 자동 배포, 슬랙 알림 CD

심화

• 대용량 파일 빠르게 처리할 수 있도록 메모리 최적화
• 다양한 디바이스 상에서 UI 테스트
• UI 테스트 자동화
• 북마크를 이용한 이어보기 기능
• PDF 주석 추가 및 메모 저장 기능
• 이미지 필터등 수정 기능
• Firebase Crashlytics 를 이용한 오류 모니터링