cuikangyuan / architecture-samples

A collection of samples to discuss and showcase different architectural tools and patterns for Android apps.

Android Architecture Blueprints

Android Architecture Blueprints is a project to showcase different architectural approaches to developing Android apps. In its different branches you'll find the same app (a TODO app) implemented with small differences.

In this branch you'll find:

• User Interface built with Jetpack Compose
• A single-activity architecture, using Navigation Compose.
• A presentation layer that contains a Compose screen (View) and a ViewModel per screen (or feature).
• Reactive UIs using Flow and coroutines for asynchronous operations.
• A data layer with a repository and two data sources (local using Room and a fake remote).
• Two product flavors, mock and prod, to ease development and testing.
• A collection of unit, integration and e2e tests, including "shared" tests that can be run on emulator/device or Robolectric.
• Dependency injection using Hilt.

Variations

This project hosts each sample app in separate repository branches. For more information, see the README.md file in each branch.

Stable samples - Kotlin

Sample	Description
main	This branch
service-locator	A simple setup that removes Hilt in favor of a service locator
livedata	Uses LiveData instead of StateFlow as the data stream solution
usecases	Adds a new domain layer that uses UseCases for business logic (not using Compose yet)
views	Uses Views instead of Jetpack Compose to render UI elements on the screen
views-hilt	Uses Views and Hilt instead together

Why a to-do app?

The app in this project aims to be simple enough that you can understand it quickly, but complex enough to showcase difficult design decisions and testing scenarios. For more information, see the app's specification.

What is it not?

• A UI/Material Design sample. The interface of the app is deliberately kept simple to focus on architecture. Check out the Compose Samples instead.
• A complete Jetpack sample covering all libraries. Check out Android Sunflower or the advanced GitHub Browser Sample instead.
• A real production app with network access, user authentication, etc. Check out the Now in Android app instead.

Who is it for?

• Intermediate developers and beginners looking for a way to structure their app in a testable and maintainable way.
• Advanced developers looking for quick reference.

Opening a sample in Android Studio

To open one of the samples in Android Studio, begin by checking out one of the sample branches, and then open the root directory in Android Studio. The following series of steps illustrate how to open the usecases sample.

Clone the repository:

git clone [email protected]:android/architecture-samples.git

This step checks out the master branch. If you want to change to a different sample:

git checkout usecases

Note: To review a different sample, replace usecases with the name of sample you want to check out.

Finally open the architecture-samples/ directory in Android Studio.

License

Copyright 2022 Google, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you 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.