Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 5.68 KB

README.md

File metadata and controls

73 lines (57 loc) · 5.68 KB
Raw

NEATFLIX

An android app built using Jetpack Compose that consumes TMDB API to display the current trending, upcoming, top rated, and popular movies and tv-shows. It also suggests films based on your watch list.

Setup Requirements

First, obtain your API key from TMDB and add it in a file named apikey.properties within the root directory:

YOUR_API_KEY="****"

Then, replace it in the build.gradle(:app) :

...
buildConfigField("String", "YOUR_API_KEY", apikeyProperties['YOUR_API_KEY'])

Finally, rebuild the project for changes to take effect and don't forget to update the references of this key in the APIService.kt file.

...
@Query("api_key") apiKey: String = BuildConfig.YOUR_API_KEY,

Tech Stack

  • MVVM Architecture - A software architecture that removes the tight coupling between components. Most importantly, in this architecture, the children don't have the direct reference to the parent, they only have the reference by observables.
  • Hilt - Hilt provides a standard way to incorporate Dagger dependency injection into an Android application.
  • Jetpack Components
    • Jetpack Compose- Modern toolkit for building native UI.
    • Android KTX - Provide concise, idiomatic Kotlin to Jetpack and Android platform APIs.
    • AndroidX - Major improvement to the original Android Support Library, which is no longer maintained.
    • Lifecycle - Perform actions in response to a change in the lifecycle status of another component, such as activities and fragments.
    • Room - Provides an abstraction layer over SQLite used for offline data caching.
    • Preferences Datastore - Jetpack DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently, and transactionally.
    • ViewModel - Designed to store and manage UI-related data in a lifecycle conscious way. The ViewModel class allows data to survive configuration changes such as screen rotations.
  • Compose Destinations - A KSP library that processes annotations and generates code that uses Official Jetpack Compose Navigation under the hood.
  • Accompanist - System UI Controller - A library that provides easy-to-use utilities for recoloring the Android system bars from Jetpack Compose.
  • Landscapist - CoilImage Loader - Landscapist is a Jetpack Compose image loading library which fetches and displays network images with Glide, Coil, and Fresco.
  • Compose Rating bar - A rating bar for Jetpack compose made by @Gowtham.
  • Compose Pagination - The Paging Library makes it easier for you to load data gradually and gracefully within your app.
  • Retrofit - Type-safe http client and supports coroutines out of the box.
  • Lottie Files for Compose - Lottie is a library for Android, iOS, and Web that parses Adobe After Effects animations exported as json with Bodymovin and renders them natively on mobile and on the web!
  • GSON - JSON Parser,used to parse requests on the data layer for Entities and understands Kotlin non-nullable and default parameters.
  • OkHttp Logging Interceptor - Logs HTTP request and response data.
  • Coroutines - Library Support for coroutines.
  • Flows - Flows are built on top of coroutines and can provide multiple values. A flow is conceptually a stream of data that can be computed asynchronously.
  • Timber - Library for easier logging.
  • Stetho - Stetho is a sophisticated debug bridge for Android applications. When enabled, developers have access to the Chrome Developer Tools feature natively part of the Chrome desktop browser.

Screenshots

PRs are welcome :)