rumaan / Android-Kotlin-Clean-Architecture

Android Sample Clean Architecture App written in Kotlin

Android Kotlin Clean Architecture

Sample project to show how a sample/test app can have some clean architecture without making it hard to understand.

Main benefits:

• Easy to understand some concepts from Clean Architecture.
• Applies & follows design principles (separation of concerns for example).
• Layer separation by modules (not packages) to set clear boundaries between each layer.
• Easy to read, scale, test and maintain.

Some extra notes:

• Simplified Clean Architecture approach.
• For Continuous integration I've used CircleCI. You can check the the config file here
• Each module will have its own readme to try and throw some light under how and why of the decisions.

Shortcuts to the module Readme

Presentation Module

Domain Module

Data Module

Quick overview of the app

Using the API endpoints

• GET http://jsonplaceholder.typicode.com/posts
• GET http://jsonplaceholder.typicode.com/users
• GET http://jsonplaceholder.typicode.com/comments

Create a simple Android app with three screens:

• Screen1: Post list screen that contains:
  • User avatar, name and username of each post.
  • Post title and ellipsized body.

Taping a cell should take you to Screen2.

• Screen2: Post Detail screen that contains:
  • User avatar, name and username of this post.
  • Post title and full post body.
  • Number of comments this post has.
  • List of comments under this post, displaying the avatar and name of the user who has written this comment and the body of this comment.

Taping the user avatar from Screen1 or Screen2 (selected user) should take you to Screen3.

• Screen3: User Detail screen that contains:
  • User related information (name, username, email, phone, address, website and company.
  • Map showing the location of this user.

Clean Architecture

Architectural approach

Architectural reactive approach

Discussions

Refer to the issues section: https://github.com/sanogueralorenzo/Android-Kotlin-Clean-Architecture/issues

Links

Medium

LinkedIn

Twitter

Moshi with Retrofit

Gradle Dependency Management with Kotlin (buildSrc)

The death of Presenters and the rise of ViewModels (AAC)

CircleCI Android Documentation

License

Copyright 2018 Mario Sanoguera de Lorenzo

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.