Introduction to GithubWatch

https://github.com/fisache/WatchGithub

WatchGithub

An android MVP structure APP with RxJava, Dagger2 and GitHub v3 API.

References

https://github.com/googlesamples/android-architecture

- References to branch to todo-mvp, dev-todo-mvp-rxjava and todo-mvp-dagger
- Concept of data flow through cache, local and remote.


https://github.com/frogermcs/GithubClient

- Use GitHub API with retrofit.
- Concept of dagger @Subcomponent.

Features

  • The sample of Android MVP architecture using Dagger2 and RxJava.
  • The GitHub API requests are restricted to 60 per a hour.
  • Use 2 POJO model(User, Repository) classes with each 2 storages(local-remote & cache-remote).

Dependencies

Android Support Packages
Dagger2
RxJava
RxAndroid
RxBinding
butterknife

picasso
retrofit
sqlbrite

mockito
espresso

adapter-rxjava, converter-gson, timber and guava

Architecture

  • WatchGithub MVP Architecture
    _config.yml

  • Dagger Object Graph _config.yml

Activity

_config.yml

[Local & Remote Storage]

Create  : - User can add new Github User clicking floating button.
          if user is not valid, snackbar is shown with warning.
          
Read    : - When app launched, all of users saved in local storage(SQLite) are updated with remote storage(GitHub API).
          - Aleary launched, users data is brought from local storage
          - Users are filterd into All User, Popular(have followers over 150), and User or Organization.
          - Also, you can search as typing the user login id.

Update/Delete  : - You can write user description(To find out who). It will place at the hint 'Go to setting..'.
                  The way writing is to click the set icon (looks like gear)
                  then, detail activity is launched, you can
                  update user's description
                  also delete user in local storage.

_config.yml

[Cache & Remote Storage]

Create :  - User's repositories is cached by replacement policy of LRU.
          - When The capacity of cache is sufficient, 
          cache will save repositories data with user login id and requested last page number

Read :   - When view user's repositories, first of all try to read from cache.
          - If not placed in cache, request to GitHub server and save to cache.
          - When You scroll down over viewed repositories, request next repositories to GitHub server and save to cache.
          - Filtering is similar to User filter (ALL, Popular(starred over 500), 
          ORIGIN or FORK and Recently pushed(before 3days).

Update :  - Update is performed when requests repositories when the repositories are not placed in cache.

Delete :  - Cache is implemented with LinkedHashMap of Java, and follows the replacement policy of LRU.
          So, Least Rencently Used data is removed when save new data to cache in full capacity.
Written on August 29, 2016