Create README.md

This commit is contained in:
2020-04-20 17:45:29 +01:00
committed by GitHub
parent b9a66c3a79
commit fbb5f28881

45
README.md Normal file
View File

@@ -0,0 +1,45 @@
# Candy Space tech test
## Requirements
- Minimum android version 23
- Permissions : Internet, Network state
## Installation
Clone this repository and import into **Android Studio**
```bash
git clone git@github.com:hmalik144/Candy_Space_tech_test.git
```
## Features
- Search the trasport api for current road status
- get Road Id, Road Status and Description from the search
- Data binding into the view model to hold data even after the activity has been destroyed by android
- SOLID coding priciples applied to keep code clean and easy to read
## Architectural Pattern
MVVM - Model View Viewmodel
## Jetpack
* [AndroidX](https://developer.android.com/jetpack)
## UI test
### 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
* [Groupie](https://github.com/lisawray/groupie) - Groupie is a simple, flexible library for complex RecyclerView layouts.
## Authors
* **Haider Malik** - *Android Developer*