MovieHunt
MovieHunt is a sample Android project using The Movie DB API based on MVVM architecture. It showcases the latest Android tech stacks with well-designed architecture and best practices.
The new v2 re-design is available.
π Check it out now!
Features
- 100% Kotlin
- MVVM architecture
- Reactive pattern
- Android architecture components and Jetpack libraries
- Single activity pattern
- Dependency injection
- CI support (Upcoming)
- Testing (Upcoming)
Tech Stacks
- Retrofit + OkHttp - RESTful API and networking client.
- Koin - Dependency injection.
- Android Architecture Components - A collections of libraries that help you design rebust, testable and maintainable apps.
- Room - Local persistence database.
- Paging - Pagination loading for RecyclerView.
- ViewModel - UI related data holder, lifecycle aware.
- LiveData - Observable data holder that notify views when underlying data changes.
- Data Binding - Declarative way to bind data to UI layout.
- Navigation component - Fragment routing handler. (Upcoming)
- WorkManager - Tasks scheduler in background jobs. (Upcoming)
RxJava - Asynchronous programming with observable streams.Replaced by Coroutine + Flow.- (Upcoming) Flow Stream of value that returns from suspend function.
- (Implementing) Coroutine Concurrency design pattern for asynchronous programming.
Epoxy - Simplified way to build complex layout in RecyclerView.Replaced by Jetpack Compose.- Coil - Image loading.
- Timber - Extensible API for logging.
- (Implementing) Jetpack Compose - Declarative and simplified way for UI development.
ScreenShots
π·
 |
 |
|---|---|
 |
 |
Architectures
We follow Google recommended Guide to app architecture to structure our architecture based on MVVM, reactive UI using LiveData / RxJava observables and data binding.
- View: Activity/Fragment with UI-specific logics only.
- ViewModel: It keeps the logic away from View layer, provides data streams for UI and handle user interactions.
- Model: Repository pattern, data layers that provide interface to manipulate data from both the local and remote data sources. The local data sources will serve as single source of truth.
Package Structures
com.enginebai.moviehunt # Root Package
βββ data # For data modeling layer
β βββ local # Local persistence database
| β βββ dao # Data Access Object for Room
| | βββ model # Model classes
β βββ remote # Remote data source
β βββ repo # Repositories for single source of data
|
βββ di # Dependency injection modules
β
βββ ui # Fragment / View layer
β βββ list # List screen Fragment and ViewModel
β βββ home # Main screen Fragment and ViewModel
| β βββ controller # Epoxy controller for RecyclerView
| β βββ models # Epoxy models for RecyclerView
β βββ details # Detail screen Fragment and ViewModel
|
βββ utils # Utility Classes / Kotlin extensions
βββ MainActivity # Single activity
βββ AppContext # Application
βββ NavigationRouter # Navigation controller
API Key
π
You will need to provide developer key to fetch the data from TMDB API.
- Generate a new key (v3 auth) from here. Copy the key and go back to Android project.
- Create a new kotlin file
ApiKey.ktin path./buildSrc/src/main/kotlin/. - Define a constant
TMDB_API_KEYwith the double quotes, it looks like
const val TMDB_API_KEY = "\"90c05******************655\""
- Add the key to build config in
./buildSrc/src/main/kotlin/Config.kt:
defaultConfig {
...
buildConfigField("String", "TMDB_API_KEY", TMDB_API_KEY)
...
}
- Perform gradle sync.
NOTE: It's important to keep the double quotes for this value, since it's used as String type build config fields, the field name in quotes, the field value in escaped quotes additionally. If you're missing the double quotes, it will build fail.
LICENSE
Copyright (c) 2020 Engine Bai
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 CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 Nov 30, 2021
2.6k Dec 25, 2022
2 Nov 15, 2022
5 Mar 31, 2022
2.1k Dec 30, 2022
5 Sep 29, 2022
3 Jun 8, 2022
14 Nov 3, 2022
2.3k Jan 3, 2023
4 Sep 28, 2022
3 Aug 25, 2022
3 Jun 18, 2022
8 Nov 29, 2022
420 Nov 29, 2022
3 Aug 1, 2022
4 Nov 9, 2022
12 Jul 7, 2022
2 Jun 17, 2022