Files
StackExchangeUsers/README.md
2020-11-20 15:37:22 +00:00

56 lines
1.8 KiB
Markdown

# Stack Exchange Users
Search for users from stackoverflow api - display a profile when clicked.
## Installation
Clone this repository with the following command
git clone https://github.com/hmalik144/StackExchangeUsers/
then open with android studio.
## Requirements
- Minimum android version 24
- Permissions : Internet, Network state
## Installation
Clone this repository and import into **Android Studio**
## Features
- SOLID coding principles applied to keep code clean and easy to read
- Android navigation library
- Livedata, with lifecycle aware results
- Data persistence with room
- Picasso for image caching
- Recycler view for easy user list display
## Architectural Pattern
MVVM - Model View Viewmodel
SOLID coding principle
## Jetpack
* [AndroidX](https://developer.android.com/jetpack/androidx)
## UI test
- AppUITest.kt
### Unit test
- RepositoryTest.kt
- MainViewModelText.ky
## Built With
* [Kodein](https://github.com/Kodein-Framework/Kodein-DI) - Painless Kotlin Dependency Injection
* [Retrofit](https://github.com/square/retrofit) - Type-safe HTTP client for Android and Java by Square, Inc
* [Picasso](https://square.github.io/picasso/) - A powerful image downloading and caching library for Android
* [Circular Image View](https://github.com/lopspower/CircularImageView) - Create circular ImageView in Android in the simplest way possible
* [Room Persistence Library](https://developer.android.com/topic/libraries/architecture/room) - The Room persistence library provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
* [Mockito](https://github.com/mockito/mockito) - Most popular Mocking framework for unit tests written in Java
## Authors
* **Haider Malik** - *Android Developer*