plaid README

The project's README from github.com/nickbutcher/plaid. As one markdown file: 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

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.6 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):

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:

License

Copyright 2015 Google LLC.

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.

plaid (nickbutcher/plaid)

android-development
Searching Database…

16.2K ·GitHub
Plaid
What is this?It's an Android app that pulls in design news and inspiration, written to showcase material design in a real application rather than in isolated demos.
Is this an app I install on my phone, or a code sample for developers?Both. It's a polished app meant to be kept installed for daily design news, and its source code doubles as a reference example of implementing material design.
How do I get it on my phone?Grab the beta from Google Play, or build it yourself: clone the repo and open the project in Android Studio 3.6 or higher.
Will it run on older Android versions?No — pre-Lollipop support is explicitly out of scope. The 1.0 code also uses vanilla components with no tests and a single module, which the 2.0 rewrite is addressing.
Is this aimed at designers or at Android developers?Both: designers get a daily feed of news and inspiration, while developers get a fairly complex real-world app to study how material design comes together.
Where does it pull design news from?Three sources: Designer News, Dribbble and Product Hunt, blended into one feed of news and inspiration.
What does the material design showcase actually demonstrate?Using material principles to build tactile, bold, understandable UIs. Styles, themes, icons, animations and transitions were the app's initial focus and are kept out of the 2.0 refactor's scope.
What is the Plaid 2.0 rewrite changing?It migrates the app to Android Architecture Components, converts it to Kotlin, and modularizes it using dynamic feature modules, following the Guide to App Architecture.
Is the current codebase a good architecture reference?Not yet — the 1.0 code has UI logic in Android classes, no tests and only one module. The 2.0 rewrite exists precisely to turn it into a modular, scalable and testable showcase.
What are similar projects?compose-samples, iosched, nowinandroid, Shizuku-Next, sunflower, lawnchair, MaterialDrawer, material-components-android
Which topics is it in?sample-app, example, news-aggregator, news, android-development, material-design, architecture, android-app, kotlin, app, design, mobile
Creator
nickbutcher
Size
33.2 MB
Stars
16.2K
Updated
CommitSep 28
Age
10y
Commits · 90 Days