Skip to content

Latest commit

 

History

History
97 lines (82 loc) · 4.86 KB

README.md

File metadata and controls

97 lines (82 loc) · 4.86 KB
Raw

Valorant Agents

License API Kotlin MVVM Coroutines

UI

Design by: Malik Abimanyu

Valorant Agents app is a small Multi-Module demo application to demonstrate modern Android application tech-stacks with a Multi-module and MVVM architecture, with emphasize on Unit & UI testing.

Tech stack & Open-source libraries

  • Minimum SDK level 21
  • Kotlin
  • Coroutines
  • Flow
  • StateFlow
  • Koin for dependency injection.
  • Hilt is a dependency injection library for Android, it can be viewed in a different branch here
  • JetPack
    • LiveData - Notify domain layer data to views.
    • Lifecycle - Dispose of observing data when lifecycle state changes.
    • Fragment-ktx - A set of Kotlin extensions that helps with fragment lifecycle.
    • ViewBinding - Allows you to more easily write code that interacts with views
    • ViewPager2 - ViewPager2 replaces ViewPager, addressing most of its predecessor’s pain-points.
    • ViewModel - UI related data holder, lifecycle aware.
    • SharedViewModel - To make communication between fragments and host activity.
    • Room Persistence - construct a database using the abstract layer.
  • Architecture
    • Multi-module design for the app.
    • MVVM Architecture (View - DataBinding - ViewModel - Model)
    • Repository pattern (NetworkBoundResource)
    • Clean Architecture approach.
  • Gradle KotlinDsl
  • Retrofit2 & OkHttp3 - Construct the REST APIs.
  • Moshi - A Modern JSON library for Android and Java.
  • Glide - For Loading images from Urls.
  • Barista - Barista makes developing UI test faster, easier and more predictable.
  • Ktlint- An anti-bikeshedding Kotlin linter with a built-in formatter.
  • Material-Components - Material design components.
  • CI/CD with github Actions - Automate, customize, and execute your software development workflows.

Architecture

Valorant Agents is Multi-modular application with a meaningful separation for layers and features with the necessary grouping. With MVVM architecture with an additional Domain layer for each module by itself.

Modules Design:

  • App
  • Core:
    • Base
    • Local
    • Remote
    • Navigator
    • UiComponents
  • Features:
    • Home
    • Agent_Details
    • Favorites
    • Agent_List

architecture

Open API

Valorant Agents uses the Valorant-api for required data. Valorant-api provides an extensive API containing data of most in-game items, assets and more!

Tasks

  • Creating the project structure

  • Implementing all features

  • Writing test cases

License

Designed and developed by 2020 AhmedVargos

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.