Skip to content

🎬 A demo project for The Movie DB based on Kotlin MVVM architecture and material design & animations.

License

Notifications You must be signed in to change notification settings

skydoves/TheMovies

Repository files navigation

TheMovies

license API Build Status License

A simple project for The Movie DB based on Kotlin MVVM clean architecture and material design & animations.

gif0 gif1

How to build on your environment

Add your API key in local.properties file.

tmdb_api_key=YOUR_API_KEY

Development process

Based on Test-driven development.

  1. API Service -> API Service Unit Test with api response mock files
  2. DAO -> DAO Unit Test
  3. Repository -> Repository Unit Test
  4. ViewModel -> ViewModel Unit Test
  5. DI & Refactoring
  6. Implmentating UI & Layouts

    tdd

Architecture

Based on mvvm architecture and repository pattern.

architecture

Specs & Open-source libraries

  • Minimum SDK 16
  • 100% Kotlin based
  • MVVM Architecture
  • Architecture Components (Lifecycle, LiveData, ViewModel, Room Persistence)
  • DataBinding
  • Material Design & Animations
  • The Movie DB API
  • Dagger2 for dependency injection
  • Retrofit2 & Gson for constructing the REST API
  • OkHttp3 for implementing interceptor, logging and mocking web server
  • Glide for loading images
  • BaseRecyclerViewAdapter for implementing adapters and viewHolders
  • WhatIf - checking nullable object and empty collections more fluently
  • Mockito-kotlin for Junit mock test
  • Timber for logging
  • Stetho for debugging persistence data & network packets
  • Ripple animation, Shared element transition
  • Custom Views ExpandableTextView

Posting

Medium - Android MVVM Architecture Components using The Movie Database API

Find this library useful? ❤️

Support it by joining stargazers for this repository. ⭐
And follow me for my next creations! 🤩

Supports ☕

If you feel like support me a coffee for my efforts, I would greatly appreciate it.
Buy Me A Coffee

License

The MIT License (MIT)

Copyright (c) 2018 skydoves

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.