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)

Searching Database…

16.2K ·GitHub
Plaid
Что это?Это Android-приложение, которое собирает новости и идеи для дизайна. Оно написано, чтобы показать material design в настоящем приложении, а не в отдельных демо-примерах.
Это приложение, которое я устанавливаю на телефон, или пример кода для разработчиков?И то и другое. Это готовое приложение, которое удобно держать установленным для ежедневных новостей о дизайне, а его исходный код одновременно служит примером реализации material design.
Как установить его на телефон?Скачайте бета-версию из Google Play или соберите приложение сами: склонируйте репозиторий и откройте проект в Android Studio 3.6 или новее.
Будет ли оно работать на старых версиях Android?Нет — поддержка версий старше Lollipop изначально не планировалась. Код версии 1.0 также использует стандартные компоненты, не содержит тестов и состоит из одного модуля — переработка в версии 2.0 как раз исправляет это.
Это для дизайнеров или для Android-разработчиков?Для тех и других: дизайнеры получают ежедневную ленту новостей и идей, а разработчики — достаточно сложное реальное приложение, на котором можно изучать, как material design применяется на практике.
Откуда оно берёт новости о дизайне?Из трёх источников: Designer News, Dribbble и Product Hunt, которые объединяются в одну ленту новостей и идей.
Что именно демонстрирует показ material design?Как с помощью принципов material design создавать осязаемые, смелые и понятные интерфейсы. Стили, темы, иконки, анимации и переходы были в центре внимания изначально, но в рефакторинг 2.0 они не входят.
Что меняется в переработанном Plaid 2.0?Приложение переводится на Android Architecture Components, переписывается на Kotlin и разбивается на модули с помощью dynamic feature modules — в соответствии с Guide to App Architecture.
Текущий код — хороший пример архитектуры?Пока нет — в коде версии 1.0 логика интерфейса находится в классах Android, тестов нет, а модуль всего один. Переработка 2.0 существует именно для того, чтобы превратить его в модульное, масштабируемое и тестируемое приложение-пример.
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