Skip to content

Latest commit

 

History

History
128 lines (95 loc) · 7.91 KB

README.md

File metadata and controls

128 lines (95 loc) · 7.91 KB
Raw

Gamedge

Min API Platform Build License

An Android application for browsing video games and checking the latest gaming news from around the world.

Built entirely using the Jetpack Compose.

The aim of this project is to showcase the latest trends in Android development by utilizing the best practices, libraries, and tools to develop a fully-fledged Android application.

Contents

Demonstration

Video

Demo.mp4

Screenshots

Tech Stack

  • Kotlin - First class and official programming language for Android development.
  • Jetpack Compose - Android’s modern toolkit for building native UI.
  • Coroutines and Flow - Official Kotlin's tooling for performing asynchronous work.
  • MVVM/MVI Architecture - Official recommended architecture for building robust, production-quality apps.
  • Android Jetpack - Jetpack is a suite of libraries to help developers build state-of-the-art applications.
    • Navigation Compose - Navigation Compose is a framework for navigating between composables while taking advantage of the Navigation component’s infrastructure and features.
    • ViewModel - The ViewModel is designed to store and manage UI-related data in a lifecycle conscious way.
    • StateFlow - StateFlow is a state-holder observable flow that emits the current and new state updates to its collectors.
    • Room - The Room library provides an abstraction layer over SQLite to allow for more robust database access.
    • DataStore - DataStore is a data storage solution that stores key-value pairs or typed objects with protocol buffers.
    • Dagger Hilt - Hilt is a dependency injection library for Android.
    • MotionLayout - MotionLayout allows you to create beautiful animations in your app without too much hassle.
    • Custom Tabs - Custom Tabs is a browser feature that gives apps more control over their web experience.
  • Accompanist - A collection of extension libraries for Jetpack Compose.
  • OkHttp - An HTTP client for making network calls.
  • Retrofit - A library for building REST API clients.
  • KotlinX Serialization - A multiplatform Kotlin serialization library.
  • Coil - An image loading library.
  • Hilt Binder - An annotating processing library that automatically generates Dagger Hilt's @Binds methods.
  • Kotlin Result - A multiplatform Result monad for modelling success or failure operations.
  • Detekt - A static code analysis library for Kotlin.
  • Ktlint - A library for formatting Kotlin code according to official guidelines.
  • Testing - The app is currently covered with unit tests and instrumentation tests.
    • JUnit - JUnit is a unit testing framework for the Java programming language.
    • Truth - Truth is a library providing fluent assertions for Java and Android.
    • MockK - MockK is a mocking library for Kotlin.
    • Coroutines Test - A library for testing Kotlin coroutines.
    • Turbine - A testing library for Kotlin Flows.
    • Dagger Hilt Test - A testing library for modifying the Dagger bindings in instrumented tests.
    • Room Testing - A library for testing Room migrations.
    • MockWebServer - A scriptable web server for testing HTTP clients.
  • Gradle's Kotlin DSL - Gradle’s Kotlin DSL is an alternative syntax to the Groovy DSL with an enhanced editing experience.
  • buildSrc - A special module within the project to manage dependencies and whatnot.

For more information about used dependencies, see this file.

Architecture

architecture

Development Setup

You'll need to supply API/client keys for the various services that the app uses in order to build the application.

IGDB

IGDB is a website dedicated to combining all the relevant information about games into a comprehensive resource for gamers everywhere. This is the main API that the app uses to fetch information about pretty much any video game there is.

Check this link on how to obtain a client ID and secret. Once you have obtained the keys, you can set them in your ~/.gradle/gradle.properties:

TWITCH_APP_CLIENT_ID=yout_client_id_here
TWITCH_APP_CLIENT_SECRET=your_client_secret_here

Gamespot

Gamespot is a video gaming website that provides news, reviews, previews, downloads, and other information on video games. The app uses its API to solely retrieve the latest news in the gaming world.

Check this link on how to obtain an API key. Once you have obtained the key, you can set it in your ~/.gradle/gradle.properties:

GAMESPOT_API_KEY=your_api_key_here

Download

Go to the Releases to download the latest APK.

Contribution

See the CONTRIBUTION.md file.

Questions

If you have any questions regarding the codebase, hit me up on Twitter.

License

Gamedge is licensed under the Apache 2.0 License.