Skip to content
A sample modular Android app written in Kotlin using Rx, Koin, Coroutines and Architecture components
Kotlin
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app [ENH] Updating readme and adding additional test cases. May 9, 2019
characters [ENH] Character search test cases Jul 9, 2019
gradle/wrapper Initial commit: Setting up modules with dynamic delivery enabled May 5, 2019
.gitignore Initial commit: Setting up modules with dynamic delivery enabled May 5, 2019
LICENCE.txt [ENH] Update readme with better explanation, working & licence. Jul 9, 2019
README.md [ENH] Add medium article link Jul 29, 2019
app_flow.gif [FIX] Gif size Jul 9, 2019
build.gradle [ENH] Character Details page ui and basic network call implemented May 5, 2019
gradle.properties Initial commit: Setting up modules with dynamic delivery enabled May 5, 2019
gradlew Initial commit: Setting up modules with dynamic delivery enabled May 5, 2019
gradlew.bat Initial commit: Setting up modules with dynamic delivery enabled May 5, 2019
settings.gradle

README.md

A sample modular Android app

This sample app has been developed with Kotlin following an MVVM architecture pattern with a modular approach.

Working

Working

Branches

master

  • Koin: Dependency injection
  • Reactive streams: Networking & Async.
  • LiveData and ViewModel: Isolate business logic and maintain state.

coroutines

  • Koin:Dependency injection
  • Coroutines: Networking & Async.
  • LiveData and ViewModel: Isolate business logic and maintain state.

Decisions

  • Koin: This is my first experiment with Koin, and it turned out to be straight-forward to implement. The performance is also great. Although, feature module support is something they are still working on.
  • Modular: The app is developed with a modular approach to support instant apps & dynamic delivery for the users. Modularity also allows us to have faster gradle build speeds, clear ownerships amongst the team & cleaner git flows. More info about modular apps can be found here.

Structure

app module is where the application initializes & characters dynamic module is where our sample screens reside. CharacterActivity holds the CharacterSearchFragment & CharacterDetailsFragment. The packages are "by-feature" for easier access.

Testing

Test cases for the CharacterSearchVM & CharacterDetailsVM have been implemented.

Write-ups

Contribution

Feel free to open an issue or submit a pull request with improvements.

Licence

MIT License

Copyright (c) 2019 Karan Trehan

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.    
You can’t perform that action at this time.