tracktor 🕵️

If you've got someone you truly admire for their fiery passion in programming, hitting that 'follow' button on GitHub might not be enough. Don't settle for the minimal info on your feed! That's where this app comes in 😉

Can be considered as a demo project to showcase MVVM with latest android development tools

<p align="center"> <img src="extras/dog_stalks_cat.gif"/> </p>

Dark Mode Available 🌙

How to use? 🤔

• Install the latest APK from releases 📥
• Add him/her to the list by entering the GitHub username
• Done 👍

Now you can see whatever he does 😜

Built With 🛠

Core 😍

• Kotlin - First class and official programming language for Android development.
• Coroutines - For asynchronous and more..
• Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
• Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
  • LiveData - Data objects that notify views when the underlying database changes.
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
  • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
  • Room - SQLite object mapping library.
• Dagger 2 - Dependency Injection Framework
• Retrofit - A type-safe HTTP client for Android and Java.
• Moshi - A modern JSON library for Kotlin and Java.
• Moshi Converter - A Converter which uses Moshi for serialization to and from JSON.
• Glide - An image loading library for Android backed by Kotlin Coroutines.
• Material Components for Android - Modular and customizable Material Design UI components for Android.
• TwinKill - A simple library, a collection of utility classes wrapped around JetPack components
• MaterialColors - Android material color palettes
• Material Dialogs - A beautiful, fluid, and extensible dialogs API for Kotlin & Android.

Testing 🥼

• JUnit - A programmer-oriented testing framework for Java
• Mockito - Most popular Mocking framework for unit tests written in Java
• Mockito-kotlin - To use Mockito with Kotlin
• Expekt - BDD assertion library for Kotlin
• Android Arch Testing - To test android architectural components
• Kotlin Coroutines Test - Testing utilities for effectively testing coroutines.
• Robolectric - Android Unit Testing Framework
• DaggerMock - A JUnit rule to easily override Dagger 2 objects

Instrumentation Testing 🛡️

• Espresso - To write concise, beautiful, and reliable Android UI tests.
• Barista - To make espresso tests faster, easier and more predictable

Architecture 🗼

This project follows the famous MVVM architecture and best practices from Google's GithubBrowserSample

Project Structure 📂

.
├── androidTest
│   └── java
│       └── com
│           └── theapache64
│               └── tracktor
│                   ├── ui
│                   │   └── activities
│                   │       ├── splash
│                   │       │   └── SplashActivityTest.kt
│                   │       ├── userdetail
│                   │       │   └── UserDetailActivityTest.kt
│                   │       └── users
│                   │           └── UsersActivityTest.kt
│                   └── utils
│                       └── DaggerMockRules.kt
├── main
│   ├── AndroidManifest.xml
│   ├── ic_launcher-playstore.png
│   ├── java
│   │   └── com
│   │       └── theapache64
│   │           └── tracktor
│   │               ├── App.kt
│   │               ├── core
│   │               │   └── events
│   │               │       ├── BaseEventSupport.kt
│   │               │       ├── EventManager.kt
│   │               │       ├── issuecomment
│   │               │       │   ├── IssueCommentEventPayload.kt
│   │               │       │   └── IssueCommentEventSupport.kt
│   │               │       ├── issues
│   │               │       │   ├── IssuesEventPayload.kt
│   │               │       │   └── IssuesEventSupport.kt
│   │               │       ├── push
│   │               │       │   ├── PushEventPayload.kt
│   │               │       │   └── PushEventSupport.kt
│   │               │       └── watch
│   │               │           └── WatchEventSupport.kt
│   │               ├── data
│   │               │   ├── local
│   │               │   │   ├── AppDatabase.kt
│   │               │   │   ├── daos
│   │               │   │   │   └── UserDao.kt
│   │               │   │   └── entities
│   │               │   │       └── UserEntity.kt
│   │               │   ├── remote
│   │               │   │   ├── ApiInterface.kt
│   │               │   │   ├── events
│   │               │   │   │   └── Event.kt
│   │               │   │   └── user
│   │               │   │       └── User.kt
│   │               │   └── repositories
│   │               │       ├── EventsRepo.kt
│   │               │       ├── PrefRepo.kt
│   │               │       └── UserRepo.kt
│   │               ├── di
│   │               │   ├── components
│   │               │   │   └── AppComponent.kt
│   │               │   └── modules
│   │               │       ├── ActivitiesBuilderModule.kt
│   │               │       ├── AppModule.kt
│   │               │       ├── DatabaseModule.kt
│   │               │       ├── NetworkModule.kt
│   │               │       ├── RepoModule.kt
│   │               │       └── ViewModelModule.kt
│   │               ├── models
│   │               │   └── UserEvent.kt
│   │               ├── ui
│   │               │   ├── activities
│   │               │   │   ├── splash
│   │               │   │   │   ├── SplashActivity.kt
│   │               │   │   │   └── SplashViewModel.kt
│   │               │   │   ├── userdetail
│   │               │   │   │   ├── UserDetailActivity.kt
│   │               │   │   │   └── UserDetailViewModel.kt
│   │               │   │   └── users
│   │               │   │       ├── UsersActivity.kt
│   │               │   │       └── UsersViewModel.kt
│   │               │   └── adapters
│   │               │       ├── EventDetailsAdapter.kt
│   │               │       ├── UserEventsAdapter.kt
│   │               │       └── UsersAdapter.kt
│   │               └── utils
│   │                   ├── DateTimeUtils.kt
│   │                   ├── EventRepoUtils.kt
│   │                   ├── NightModeUtils.kt
│   │                   ├── StringUtils.kt
│   │                   └── test
│   │                       └── OpenForTesting.kt
│   └── res
│       ├── drawable
│       │   ├── ic_baseline_add_24.xml
│       │   ├── ic_baseline_close_24.xml
│       │   ├── ic_baseline_delete_outline_24.xml
│       │   ├── ic_hacker_100.xml
│       │   ├── ic_launcher_foreground.xml
│       │   └── ic_night_mode_24.xml
│       ├── drawable-night
│       │   └── ic_night_mode_24.xml
│       ├── layout
│       │   ├── activity_splash.xml
│       │   ├── activity_user_detail.xml
│       │   ├── activity_users.xml
│       │   ├── item_event_detail.xml
│       │   ├── item_user_event.xml
│       │   └── item_user.xml
│       ├── mipmap-anydpi-v26
│       │   ├── ic_launcher_round.xml
│       │   └── ic_launcher.xml
│       ├── mipmap-hdpi
│       │   ├── ic_launcher.png
│       │   └── ic_launcher_round.png
│       ├── mipmap-mdpi
│       │   ├── ic_launcher.png
│       │   └── ic_launcher_round.png
│       ├── mipmap-xhdpi
│       │   ├── ic_launcher.png
│       │   └── ic_launcher_round.png
│       ├── mipmap-xxhdpi
│       │   ├── ic_launcher.png
│       │   └── ic_launcher_round.png
│       ├── mipmap-xxxhdpi
│       │   ├── ic_launcher.png
│       │   └── ic_launcher_round.png
│       ├── values
│       │   ├── colors.xml
│       │   ├── dimens.xml
│       │   ├── ic_launcher_background.xml
│       │   ├── strings.xml
│       │   └── styles.xml
│       └── values-night
│           ├── colors.xml
│           └── styles.xml
├── sharedTest
│   └── java
│       └── com
│           └── theapache64
│               └── tracktor
│                   └── utils
│                       └── test
│                           └── observeForTesting.kt
└── test
    ├── java
    │   └── com
    │       └── theapache64
    │           └── tracktor
    │               ├── data
    │               │   ├── local
    │               │   │   └── daos
    │               │   │       └── UserDaoTest.kt
    │               │   └── repositories
    │               │       └── EventsRepoTest.kt
    │               ├── ui
    │               │   └── activities
    │               │       ├── splash
    │               │       │   └── SplashViewModelTest.kt
    │               │       ├── userdetail
    │               │       │   └── UserDetailViewModelTest.kt
    │               │       └── users
    │               │           └── UsersViewModelTest.kt
    │               └── utils
    │                   ├── DateTimeUtilsTest.kt
    │                   └── StringUtilsKtTest.kt
    └── resources
        └── robolectric.properties

77 directories, 88 files

Credits 🤗

• 🤓 Icons are from flaticon.com
• 🖌️ Design inspired from AnimeXStream
• 💽 Data from GitHub API v3

TODO 🗒️

• Support more GitHub events
• Add more test cases

Author ✍️

• theapache64