appearance/Qwez

Android Quiz App written with mvvm architecture (Playground App)

Qwez

Architecture:

• MVVM: Model-Viewmodel-Model
• Repository: One repository per data type e.g sharedpreferences repository, Firebase repository etc
• Uses a RxJava Bus for communication between different parts of the application.
• Interactor's (Aka Use-cases): Single responsibility interactor classes for interacting with repository/repositories, services, etc. This is where the applications "business logic" resides.
• App is highly extensible. It can easily be modified and added with further behaviour. To add new "UI package", one must:
  • Create Activity (And/or Fragment(s))
  • Create Activity Module (For dependency injection), add module to Dagger Application Component
  • Bind module to activity in "di" package
  • Create Viewmodel
  • Create Viewmodel factory
  • Provide all dependencies via Module, provide dependencies in parameters to factory+viewmodel

Following libraries are using in this app:

Design

• Dagger2 for dependency injection.
• RxJava for composing asynchronous and event-based programs (Observer-Observable pattern).
• RxAndroid for added RxJava classes/functionality for Android.
• Butterknife for view binding.
• Glide for image loading.

Data

• Firebase:
  • Firestore for online database.
  • Firebase Auth for user authorization.
• Room for local database.

UI

• Material Design for helping creating UI in coordinance with Google's Material Design guidelines.
• Material Dialogs for creating dialogs.
• Lottie for animations.

Networking

• Retrofit (+okhttp for interceptor) for API calls.

Testing

• Mocktio for testing. Very powerful testing library.

Logging/Debugging

• Leak Canary for detecting any memory leaks.
• Timber for simplified logging.
• Stetho for debugging of network/local database.

Others

• Standard libraries: AppCompat, JUnit, Espresso, CardView, RecyclerView, support libraries,Apache Commons Text...

Wrappers

Application have some RxJava wrappers for different parts of the application, to ease reactive programming within the app:

• SharedPreferences
• Firebase

License

MIT License

Copyright 2019 AliAmid93

Permission is hereby granted, free of charge, to any person obtaining a 
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation 
the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included 
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.