alex-cosmas / maishameds Goto Github PK

👀 Writing MaishaMeds Interview Solution App using Android Architecture Components, in 100% Kotlin, using Android Jetpack Components.

Before every commit, make sure you run the following bash script:

./codeAnalysis

To test code coverage, run the following bash script:

./coverage

If you have Fastlane installed, you can run the develop lane:

fastlane branch conf:debug

To check for dependency updates, run the following gradlew command:

./gradlew dependencyUpdate

To inspect the local db/cache, there are two ways to do it:

Open Chrome, and type in this URL. Uses Stetho, which is bundled on the debug APK

chrome://inspect/

Using Android Studio database inspector - Bump up the minimum version to 26, inside the Dependencies.kt

object AndroidSdk {
    const val minSdkVersion = 26 // is set to 23 on the repo
    ...
}

Refer to this issue, if you get any issues running the lint commands on the terminal 🚀

Develop an application that uses Typicode API to do the following:

• Hit the /posts endpoint and displays the results in a list

• Tech-stack

  • Kotlin - a cross-platform, statically typed, general-purpose programming language with type inference.
  • Coroutines - perform background operations.
  • Flow - handle the stream of data asynchronously that executes sequentially.
  • KOIN - a pragmatic lightweight dependency injection framework.
  • Retrofit - A type-safe HTTP client for Android.
  • Chuck - An in-app HTTP inspector for Android OkHttp clients
  • Jetpack
    • Room - a persistence library provides an abstraction layer over SQLite.
    • LiveData - is an observable data holder.
    • Lifecycle - perform action when lifecycle state changes.
    • ViewModel - store and manage UI-related data in a lifecycle conscious way.
  • Stetho - application debugging tool.
  • Timber - a highly extensible android logger.
  • Leak Canary - a memory leak detection library for Android.

• Architecture

  • MVVM - Model View View Model

• Tests

  • Unit Tests (JUnit) - a simple framework to write repeatable tests.
  • MockK - mocking library for Kotlin
  • Kluent - Fluent Assertion-Library for Kotlin
  • Kakao - Nice and simple DSL for Espresso in Kotlin

• Gradle

  • Gradle Kotlin DSL - For reference purposes, here's an article explaining the migration.
  • Plugins
    • Ktlint - creates convenient tasks in your Gradle project that run ktlint checks or do code auto format.
    • Detekt - a static code analysis tool for the Kotlin programming language.
    • Spotless - format java, groovy, markdown and license headers using gradle.
    • Dokka - a documentation engine for Kotlin, performing the same function as javadoc for Java.
    • jacoco - a Code Coverage Library

• CI/CD

  • Github Actions
  • Fastlane - App automation done right

All the dependencies (external libraries) are defined in the single place - Gradle buildSrc folder. This approach allows to easily manage dependencies and use the same dependency version across all modules.

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.