Skip to content
An Android app which provides design news & inspiration as well as being an example of implementing material design.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update CircleCI config for v2.1 Apr 8, 2019
about Update About screen for day/night theme. Apr 26, 2019
app Bump versionName to 1.1.0 Apr 27, 2019
art Different icon & package for debug builds. Jul 10, 2018
core Tweaked handling of null drawable. May 21, 2019
designernews Address review comments. Apr 26, 2019
dribbble Address review comments. Apr 26, 2019
gradle/wrapper Add UiModel to Dribbble Shot Mar 13, 2019
screenshots Initial commit. Oct 30, 2015
scripts Store gcloud error code and surface it later Jul 31, 2018
search More dark theme fixes. Apr 26, 2019
test_shared Remove the Unconfined from CoroutinesMainDispatcherRule and added a t… Mar 21, 2019
third_party/bypass Gradle includeGroup (#615) Mar 1, 2019
.gitignore Add google-services.json to gitignore Jul 31, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Jan 28, 2019
LICENSE Initial commit. Oct 30, 2015
NOTICE Initial commit. Oct 30, 2015
PRIVACY.md Removing permission reuqest from DN Login Jul 17, 2018
README.md README: Point CircleCI integration to new location Apr 29, 2019
build.gradle Address review comments. Apr 26, 2019
core_dependencies.gradle More dark theme fixes. Apr 26, 2019
gradle.properties Initial commit after AndroidX conversion using Android Studio refacto… Oct 21, 2018
gradlew Update Gradle wrapper JAR and gradlew Nov 28, 2018
gradlew.bat Update Gradle wrapper JAR and gradlew Nov 28, 2018
pull_request_template.md Create pull_request_template.md (#677) Mar 27, 2019
repositories.gradle [SECURITY] Resolve Dependencies over HTTPS Mar 5, 2019
settings.gradle Creating a test-shared module Jul 18, 2018
test_dependencies.gradle Add a test rule to allow us to change Dispatcher.Main Mar 21, 2019

README.md

[ 🚧 Work in progress 👷‍♀️👷🔧️👷🔧 🚧 ] Plaid 2.0

Rewriting Plaid using Android Architecture Components, in Kotlin.

👀 "Up for grabs" issues – We're happy to get your contributions on those!

👍 Comments and new issues created are welcomed.

🛑 We're currently not accepting external PRs that touch on the app's architecture.

CircleCI

Background

Plaid was written with one big goal: showcase material design in Android in a real application. While Plaid successfully achieved its goal, from an architecture point of view, it lacks all features that would make it a modular, scalable, testable and maintainable app: with UI logic in Android classes, no tests and only one module. Plaid represents a great real world app example: it provides a fairly complex set of functionalities, it has technical debt, it has features that have to be dealt with as APIs are being removed. All of these problems are encountered by many projects in the Android community and therefore, make Plaid a suitable showcase for all the advantages that architecture components bring.

More information

Goals

  • Migrate Plaid to Architecture Components. The refactoring will follow the architecture described in Guide to App Architecture.
  • Convert to Kotlin, while migrating to Architecture Components.
  • Modularize the app using dynamic feature modules.
  • Showcase the extensibility of the architecture by adding an extra data source, once the migration is finished.

Non-Goals

Changes to the styles, themes, icons, animations, transitions or any other UI elements that were the initial focus of Plaid, are outside the scope of this refactoring.

Android Studio IDE setup

Plaid requires Android Studio version 3.4 or higher.

Plaid uses ktlint to enforce Kotlin coding styles. Here's how to configure it for use with Android Studio (instructions adapted from the ktlint README):

  • Close Android Studio if it's open

  • Download ktlint using these installation instructions

  • Inside the project root directory run:

    ./ktlint --apply-to-idea-project --android

  • Remove ktlint if desired:

    rm ktlint

  • Start Android Studio


Plaid 1.0

Design news and inspiration.

Plaid is a showcase of material design that we hope you will keep installed. It pulls in news & inspiration from Designer News, Dribbble & Product Hunt. It demonstrates the use of material principles to create tactile, bold, understandable UIs.

Install on Google Play (Beta Testing)

Screenshots

Non-Goals

Plaid is a UI sample and seeks to demonstrate how to implement material design. To make this as clear as possible it explicitly does not attempt to:

  • Provide opinionated architecture/testing advice; it utilizes vanilla Android components. For advice on this, I'd recommend Blueprints.
  • Support pre-Lollipop devices. Doing so is entirely possible, but complicates things. For advice on doing this, see this fork.

License

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