Skip to content

Simple Android MVP Architecture sample using the Github API

License

Notifications You must be signed in to change notification settings

tunjos/android-mvp

Repository files navigation

Android-MVP

...Simple Android MVP Architecture sample using the Github API

Cover 1

Info

The Github Logo and GitHub icons are a property of Github

Screenshots

Architecture

This app is built using the MVP - Model View Presenter Pattern.
Communication between different layers is done with the use of interfaces in order to hide internal logic.

MVP

APIs Used

https://api.github.com/users/{username}/repos
https://api.github.com/repos/{owner}/{repo}

Libraries used

  • Butter Knife: Field and method binding for Android views.
  • Dagger 2: A fast dependency injector for Android and Java.
  • Retrofit: A type-safe HTTP client for Android and Java.
  • RxAndroid: RxJava bindings for Android.
  • Timber: A logger with a small, extensible API which provides utility on top of Android's normal Log class.

Building

To build a debug version, run this from the root of the project:

./gradlew app:assembleDebug

A Debug .apk file will be created in the app/build/outputs/apk/ folder.

Quality Control

To run the unit tests:

./gradlew app:testDebugUnitTest

Test Summary will be generated in the app/build/reports/tests/testDebugUnitTest/index.html file.

To run instrumentation tests:

./gradlew app:connectedAndroidTest

Test Summary will be generated in the app/build/reports/androidTests/connected/index.html file.

License

Copyright 2018 Tunji Olu-Taiwo

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Releases

No releases published

Packages

No packages published

Languages