Skip to content

Latest commit

 

History

History
108 lines (95 loc) · 4.28 KB

README.md

File metadata and controls

108 lines (95 loc) · 4.28 KB
Raw

Valorant Guide

License API Kotlin MVVM Coroutines


A sample android app consuming Valorant API to display valorant agents, maps and weapons, it has been built with Architecture Components and MVVM pattern.


ValoGuide

Tech stack & Open-source libraries

  • Minimum SDK level 26
  • Kotlin
  • Coroutines
  • Koin for dependency injection.
  • Firebase for Crashlytics and Analytics
  • Admob
  • CircleIndicator A lightweight indicator lists
  • 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
    • ViewModel - UI related data holder, lifecycle aware.
    • Navigator - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app.
  • 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.
  • Coil - For Loading images from Urls.

Architecture

ValoGuide 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
    • Api
    • Di
    • Extensions
    • Network
    • Features
      • Agents
        • Data
          • Repository
          • Response
        • Di
        • Ui
          • Adapter
          • ViewState
      • Maps
        • Data
          • Repository
          • Response
        • Di
        • Ui
          • Adapter
          • ViewState
      • Weapons
        • Data
          • Repository
          • Response
        • Di
        • Ui
          • Adapter
          • ViewState

Open API

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

In progress 🚧.

  • Write tests
  • Code cleanup

License

Designed and developed by .fingerfire - 2023 

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.