Android-CleanArchitecture README

The project's README from github.com/android10/Android-CleanArchitecture. As one markdown file: README.md.

Android-CleanArchitecture

New version available written in Kotlin:

Architecting Android… Reloaded

Introduction

This is a sample app that is part of a blog post I have written about how to architect android application using the Uncle Bob's clean architecture approach.

Architecting Android…The clean way?

Architecting Android…The evolution

Tasting Dagger 2 on Android

Clean Architecture…Dynamic Parameters in Use Cases

Demo video of this sample

Clean architecture

http://fernandocejas.com/2015/07/18/architecting-android-the-evolution/

Architectural approach

http://fernandocejas.com/2015/07/18/architecting-android-the-evolution/

Architectural reactive approach

http://fernandocejas.com/2015/07/18/architecting-android-the-evolution/

Local Development

Here are some useful Gradle/adb commands for executing this example:

Discussions

Refer to the issues section: https://github.com/android10/Android-CleanArchitecture/issues

Code style

Here you can download and install the java codestyle. https://github.com/android10/java-code-styles

License

Copyright 2018 Fernando Cejas

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.

http://www.fernandocejas.com

Android Arsenal

Buy Me A Coffee

Android-CleanArchitecture (android10/Android-CleanArchitecture)

Searching Database…

What is this?A sample Android app that shows how to architect an application using Uncle Bob's clean architecture approach — it accompanies Fernando Cejas's series of blog posts on the topic.
Is it a real app I can install, or more of a learning resource?Both, but learning is the point: it's a working example app you can build and run on a device, written to illustrate the architecture explained in the blog posts.
How do I get it running on a device?Clone it and run './gradlew installDebug' — that installs the debug APK on the currently connected device. './gradlew clean build' builds the whole example and runs tests plus lint.
What do I need installed before I can build it?It's a standard Gradle-based Android project: every documented command runs through the bundled './gradlew' wrapper and the APK is deployed with adb, so you need an Android development setup. No Dockerfile or CI config ships with the repo.
Is this still the current version of the project?No — the README points to a newer edition of the sample rewritten in Kotlin ('Architecting Android... Reloaded'), and this Java version's copyright header dates to 2018.
Which blog posts does this sample accompany?Four: 'Architecting Android...The clean way?', 'Architecting Android...The evolution', 'Tasting Dagger 2 on Android' and 'Clean Architecture...Dynamic Parameters in Use Cases'. The README also links a demo video of the app in action.
Does the sample show how dependency injection fits in?Yes — one of the companion posts is 'Tasting Dagger 2 on Android', so the app doubles as a practical example of wiring dependencies with Dagger 2 on Android.
If I copy this architecture into my team's app, is there a code style to follow?Yes, the README links a downloadable Java codestyle you can install, so your codebase can match the conventions used in the sample.
Creator
android10
Size
5.1 MB
Stars
15.5K
Updated
CommitDec 28
Age
12y
Commits · 90 Days