inventidevelopment/androidskeleton

Simple template app based on jsonplaceholder example REST API

Android Skeleton

Simple template app based on jsonplaceholder example REST API.

Goals

TODO explain our goals

Architecture

We use simplified version of clean architecture.

• Data - not sure yet how to handle this layer in this template, this can be different from app to app so it may be appropriate to use something simple like SharedPreferences or we can create more flavours(branches?) of this layer
• Domain - Use cases and stuff
• Presentation - MVP maybe parts of MVI on some complex forms

Glue between these layers is RxJava

Package by feature inside every main layer

Used libraries

• RxJava
• RxAndroid
• Dagger2
• ButterKnife
• RxBinding
• Retrofit
• Mosby
• Conductor

Inspiration & Acknowledgements

Articles

• https://fernandocejas.com/2014/09/03/architecting-android-the-clean-way/
• https://fernandocejas.com/2015/07/18/architecting-android-the-evolution/
• Everything Jake Wharton ever done :)
• https://hackernoon.com/configuring-android-project-little-things-that-matter-d6a9d34c1ce0 (whole series)
• TODO

Repos

• https://github.com/googlesamples/android-architecture
• https://github.com/android10/Android-CleanArchitecture
• https://github.com/sockeqwe/mosby-conductor/tree/master/app

How to use this

TODO

TODO List

• Setup github project
• Add all essential dependencies and make sure everything compiles
• Create Main activity as an conductor host
• Create first example screen with view(conductor), presenter
• Translate everything to kotlin
• Setup dagger for everything
• Setup leakCanary
• Setup retrofit with first api call
• Architect use cases and domain logic
• Architect Repository and data layer
• Remote error handling
• Correct repository data source observable composition
• Presenter subscription management and config change
• Configuration change data management
• All the preparations for for testing(mock flavour etc)
• Write unit and UI tests
• Firebase branch

Reactive types

Observable/Flowable - onSubscribe onNext(T value)* (onComplete() | onError(Throwable e))?

Single - onSubscribe (onSuccess(T value) | onError(Throwable e)?

Completable - onSubscribe (onComplete() | onError(Throwable e))?

Maybe - onSubscribe (onSuccess(T value) | onError(Throwable e) | onComplete())?

License

Copyright 2017 Inventi Development s.r.o

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

androidskeleton's Issues

Add user avatar to post list

Show avatars of post authors in post list, probably use glide to achieve that

Modularize

Create 3 basic modules, presentation, domain, data

Solution for quick new screen creation

Some intellij template or something to speed up new screen creation(new Controller, View, Component, Module, Presenter .... )

Demonstrate MVI on PostAdd screen

Useful resources

• http://hannesdorfmann.com/android/mosby3-mvi-1

• https://github.com/sockeqwe/mosby/tree/master/sample-mvi/src/main/java/com/hannesdorfmann/mosby3/sample/mvi

• https://www.youtube.com/watch?v=0IKHxjkgop4

Implement granular changes to all recyclerViews with DiffUtils

Article for inspiration https://hellsoft.se/a-nice-combination-of-rxjava-and-diffutil-fe3807186012

Generalize use cases for different RxJava2 types

Find a way to use one use cases for Observable, Flowable, Single, Maybe, Completable etc or some other way to share code