jumaallan/huawei-hms

Mobile app with Huawei Mobile Services [Huawei Interview Solution], for the Huawei Mobile Service Engineer Role

[ 🚧 Work in progress 👷‍♀️⛏👷🔧️🚧 ] Huawei HMS

👀 Writing Huawei HMS App using Android Architecture Components, in 100% Kotlin, using the Huawei Map Service SDK - part of Huawei Mobile Services.

I have committed the agconnect-services json file, but should be replaced with one generated on your side

Background

Develop a demo app, using the Huawei Map Kit and Location Kit SDK:

• When the user opens the app, it should locate the user's current location and show on the Huawei Map.
• Mark the user's current location on the Map with a star/marker, and pop up the user's current address when they click the star/marker - show the address description not the Geocoding value.
• User can move and click on the map, and the marker will move to the point as the user clicks - popup the address description when the user pins a point on the map.

Background

Some screenshots to show the app flow (in the screenshots folder):

Project characteristics

This project brings to table set of best practices, tools, and solutions:

• 100% Kotlin
• Model-View-ViewModel architecture
• Android Jetpack
• CI pipeline
• Testing
• Dependency Injection
• Material design

Tech-stack

Min API level is set to 19, so the presented approach is suitable for over 98% of devices running Android. This project takes advantage of many popular libraries and tools of the Android ecosystem. Most of the libraries are in the stable version.

• Tech-stack

  • Kotlin + Coroutines - perform background operations
  • KOIN - dependency injection
  • Retrofit - networking
  • Jetpack
    • LiveData - notify views about database change
    • Lifecycle - perform action when lifecycle state changes
    • ViewModel - store and manage UI-related data in a lifecycle conscious way
  • Coil - image loading library with Kotlin idiomatic API
  • Stetho - application debugging tool

• Architecture

  • MVVM - application level
  • Android Architecture components (ViewModel, LiveData, SafeArgs plugin)

• Tests

  • Unit Tests (JUnit)
  • Mockito + Mockito-Kotlin
  • Kluent

• Gradle

  • Gradle Kotlin DSL
  • Custom tasks
  • Plugins (Ktlint, Detekt, Versions, SafeArgs)

How it works

The app uses the MVVM Architecture. On app open, the Splash Activity is fired up, and opens up the MapsActivity. The Map will read the key from the secrets - committed but should not be, and then tries to load the map.

When the map is fully loaded, we use the location kit to try and get the users current location, zoom the map in there and show a marker. The user can click on the marker to show the nearby places. On Marker click, the app will make an HTTP call to the reverse geo code api.

In here, the Map Activity will call the MapViewModel, which in turn makes the network call inside the MapRepository. We use a suspend function to make an asynchronous call to the Huawei API. On response, we save the nearby locations to room database, and then display them on the Map Page - using LiveData, which allows us to listen to changes on the database. We then show data about the nearby places in a recyclerview at the bottom.

On Map drag and click, we create a new marker on that position. On marker click, we nuke the database - delete old nearby places, and make a new HTTP call to get the nearby places, and same flow happens, and we display it.

The app has two build variants - debug and release

Getting started

There are a few ways to open this project.

Android Studio

1. Android Studio -> File -> New -> From Version control -> Git
2. Enter https://github.com/jumaallan/huawei-hms.git into URL field

Command line + Android Studio

1. Run git clone https://github.com/jumaallan/huawei-hms.git
2. Android Studio -> File -> Open

License

MIT License

Copyright (c) 2020 Juma Allan

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  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.