Plaid

Additional

Language
Java
Version
0.9.9 (Nov 11, 2016)
Created
Oct 30, 2015
Updated
Nov 3, 2018
Owner
Nick Butcher (nickbutcher)
Contributors
Ben Weiss (keyboardsurfer)
Janusz Bagiński (jbaginski)
Matthew Precious (mattprecious)
Zac Sweers (hzsweers)
Gabriel Ittner (gabrielittner)
Takahiro Menju (takahirom)
Antoine Merle (castorflex)
Hannes Dorfmann (sockeqwe)
ataulm
Roman Nurik (romannurik)
Nam Nguyen Hoai (eneim)
Yusuke Konishi (konifar)
tiembo
jrodbx
prempalsingh
start141
Piotr Ekert (piotrek1543)
Nick Butcher (nickbutcher)
Show all (40)40
Activity
Badge
Generate
Download
Source code
APK file

Advertisement

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

Rewriting Plaid using Android Architecture Components, in Kotlin.

🛑 During the initial development stage, we're not accepting external PRs. 🛑

👍 Comments and new issues created are welcomed.

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.

Read more

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.2 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:

    curl -sSLO https://github.com/shyiko/ktlint/releases/download/0.27.0/ktlint && chmod a+x ktlint

  • Inside the project root directory run:

    ktlint --apply-to-idea-project --android

  • Remove ktlint if desired:

    rm ktlint

  • Start Android Studio