kaorumuta / qiitachecker

A sample app to watch the articles in Qiita and just my practice to implement with MVVM + Clean Architecture

QiitaChecker

What Is This App?

QiitaChecker enables you to watch the latest articles of Qiita. However, some problems are existed and should be revised.

App Architecture

In this app, I adopted MVVM + Clean Architecture. A Detail is shown in this figure.
This app separates three layers, presentation layer, domain layer, and data layer. In presentation layer, UI Event and Databinding are handled with ViewController and ViewModel. Essentially, presentation logics are stored in ViewModel. In domain layer, UseCase stores and performs business logics and translates received immutable data (Entity) into Model through Translator. In data layer, Repository receives immutable data with DataStore and pass it to UseCase. Also, DataStore receives the immutable data as Entity from QiitaAPI and pass Entity to Repository.

How To Run This App

1. rbenv, carthage, mint setup
   Just run this command in your terminal

brew install rbenv ruby-build
brew install carthage
brew install mint

2. rbenv install
   Just run this command in your terminal

rbenv install $(cat .ruby-version)

3. set the path in .bashrc and run .bashrc
   Write the command in .bashrc to set the path

[[ -d ~/.rbenv  ]] && \
  export PATH=${HOME}/.rbenv/bin:${PATH} && \
  eval "$(rbenv init -)"

and run it with this command

source ~/.bashrc

4. bundler install
   Just run this command in your terminal

gem install bundler:2.0.1

5. run Makefile and open the workspace
   Just run this command in the project root in your terminal

make

and

open QiitaChecker.xcworkspace

Future Work

• Improve UX (ex. add checkbox in TagCell to watch whether item is selected or not)
• add the function to search tags and posts by themselves

Used Libraries

• QiitaAPI
• RxSwift
• RxRealm
• Alamofire
• Parchment
• Nuke
• XcodeGen
• SwiftLint
• SwiftGen

Acknowledgements (Reference for Me Specifically)

• https://medium.com/@rockname/clean-archirecture-7be37f34c943
• https://www.kagemiku.com/blog/archives/442
• https://github.com/YutoMizutani/architectures
• https://www.slideshare.net/ssuser3bddf8/clean-architecture-71046114
• https://qiita.com/H_Crane/items/d2d316b086745417ffae
• https://qiita.com/shira-shun/items/778e65308f26860664fc
• https://medium.com/@aliakhtar_16369/rxrealm-realmswift-part-7-cf83c4a3edb5

License

Under MIT License

qiitachecker's Issues

Implement to watch articles in specific tag with Parchment

What is this issue?

Add the functions in this app

• Watch articles in specific tag which users decide in pickerView
• Implement paging with Parchment

Introduce XcodeGen

What is this issue?

To manage project file (.xcodeproj) in yaml,

• Install XcodeGen
• Create yaml

Load the latest article in Qiita

What is this issue?

load the latest article via QiitaAPI by using Alamofire

Build failed in Xcode 12.0

What is this issue?

Build failed due to this error

Module compiled with Swift 5.2.4 cannot be imported by the Swift 5.3 compiler

Environment
MacOS: Catalina
Xcode: 12.0

Screenshot (Optional)

Create Documentation

What is this issue?

README is not created

Design Main Screen

What is this issue?

Implementation in main screen

• Use Parchment
• Watch the article of Qiita as a guest

Introduce Dependency Manager

What is this issue?

Try to

• Install CocoaPods
• Install Carthage (High Priority)

I'd like to manage any frameworks or OSS in Carthage as far as possible. In case of unsupported frameworks or OSS in Carthage, Introduce CocoaPods

Consider app architecture

What is this issue?

To do unit test easily,

• Introduce suitable app architecture following SOLID principle, which is a major software architecture principle)

In this app, practice to implement in MVVM+Clean Architecture

Create Issue and Pull Request Template

To unify the message form of Issues and Pull Requests,

• create ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE