From 268d656d0d61a6a8dc6de2f5906bb875f0361d63 Mon Sep 17 00:00:00 2001 From: hmalik144 Date: Sun, 23 Feb 2020 18:41:32 +0000 Subject: [PATCH 1/2] Create README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e68d1b --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +Road status search + +## Requirements + + - Minimum android SDK version 24 + - Permissions : Internet + +## How to run + + - Add you API_key and Application_id in the keys.xml in the resources directory + - Build the project via android studio and launch on a device or emulator + - Build the project and launch the UI test from the in the configuration options + +## 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 + +### Test case One + - UI test for searching road status via the app + +## 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 + + +## Authors + +* **Haider Malik** - *Android Developer* From af19efb0b3cc16fa4e7bc6f1308e83689d3d8823 Mon Sep 17 00:00:00 2001 From: hmalik144 Date: Sun, 23 Feb 2020 18:42:54 +0000 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e68d1b..0d230f9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Road status search +# Road status search ## Requirements