Git Product home page Git Product logo

theapache64 / tracktor Goto Github PK

View Code? Open in Web Editor NEW
63.0 2.0 7.0 3.26 MB

A GitHub user tracking app, inspired from a GIF. ๐Ÿ•ต๏ธ Can be considered as a demo project to showcase MVVM with latest android development tools

Home Page: https://github.com/theapache64/tracktor/blob/master/extras/dog_stalks_cat.gif

Kotlin 100.00%
coroutines coroutines-flow livedata view-model view-binding room dagger2 dagger-mock retrofit moshi

tracktor's Introduction

tracktor ๐Ÿ•ต๏ธ

GitHub issues GitHub forks GitHub stars GitHub license Twitter

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

Dark Mode Available ๐ŸŒ™

dark_screenshots

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 ๐Ÿฅผ

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 ๐Ÿค—

TODO ๐Ÿ—’๏ธ

  • Support more GitHub events
  • Add more test cases

Author โœ๏ธ

  • theapache64

tracktor's People

Contributors

theapache64 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

tracktor's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.