https://github.com/hitherejoe/mvvm_hacker_news
Android MVVM experiment project using the official Data Binding library
https://github.com/hitherejoe/mvvm_hacker_news
Last synced: 24 days ago
JSON representation
Android MVVM experiment project using the official Data Binding library
- Host: GitHub
- URL: https://github.com/hitherejoe/mvvm_hacker_news
- Owner: hitherejoe
- Created: 2015-08-25T11:21:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-22T09:26:22.000Z (over 7 years ago)
- Last Synced: 2025-03-28T12:07:40.438Z (about 1 month ago)
- Language: Java
- Size: 4.61 MB
- Stars: 878
- Watchers: 35
- Forks: 119
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
MVVM using Data Binding [](https://travis-ci.org/hitherejoe/MVVM_Hacker_News)
=======================
I wanted to experiment creating an MVVM structured project using the official Data Binding library,
so I stripped back an [old project](https://github.com/hitherejoe/HackerNewsReader) of mine and replaced relevant codebase with an MVVM approach. This is still experimental,
so I'd love to hear any suggestion / improvements to the approach!
Currently writing a Medium article which should explain more... but for now:
Posts
-----
Post cards displayed on the Post Screen (left, above) are built using the following classes:
[Post](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/model/Post.java) - The post object
[PostAdapter](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/view/adapter/PostAdapter.java) - The RecyclerView adapter used to set the view model
[PostViewModel](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/viewModel/PostViewModel.java) - The view model used to manage the display of the posts
[item_post](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/res/layout/item_post.xml) - The XML layout file which displays the post card
Comments
--------
Comments displayed on the Comment Screen (right, above) are built using the following classes:
[Comment](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/model/Comment.java) - The comment object
[CommentAdapter](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/view/adapter/CommentAdapter.java) - The RecyclerView adapter used to set the corresponding view model. Comments work a bit differently
from posts as this adapter uses logic to choose to use one of two view models based on the comment type
[CommentViewModel](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/viewModel/CommentViewModel.java) - The view model used for standard comments on a post
[CommentsHeaderViewModel](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/java/com/hitherejoe/mvvm_hackernews/viewModel/CommentHeaderViewModel.java) - The view model used as a header for the post text with an ASK post
[item_comment](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/res/layout/item_comment.xml) - The XML layout file which displays a standard comment
[item_comments_header](https://github.com/hitherejoe/MVVM_Hacker_News/blob/master/app/src/main/res/layout/item_comments_header.xml) - The XML layout file used to display the header for an ASK post
Requirements
------------
- [Android SDK](http://developer.android.com/sdk/index.html).
- Android [5.1 (API 22) ](http://developer.android.com/tools/revisions/platforms.html#5.1).
- Android SDK Tools
- Android SDK Build tools 23.0.0.0
- Android Support Repository
- Android Support library
Building
--------
To build, install and run a debug version, run this from the root of the project:
./gradlew installRunDebug
Testing
--------
To run **unit** tests on your machine using [Robolectric] (http://robolectric.org/):
./gradlew testDebugUnitTest
To run automated tests on connected devices:
./gradlew connectedAndroidTest