Android implementation of the Flamingo Design System

Related tags

Kotlin Projects android kotlin ksp design-system playground-app jetpack-compose
Overview

It is an Android implementation of the Flamingo Design System.

It Consists Of:

Palette, theme colors, typography, icon set, illustrations, gradients and UI components.

Useful links

Playground App

Flamingo Playground is a demonstration app that contains live (meaning generated using real code) demos of various design system components (see It consists of).

Here you can see a brief demonstration of the design system: Youtube Videos

Download Flamingo Playground App

Getting Started

  1. Download .aars of flamingo and flamingo-roboto-font modules from the releases page

  2. Put them in /project name/libs/ folder

  3. Add this to your module's build.gradle(.kts):

    implementation(files("$rootDir/libs/flamingo-LATEST_VERSION.aar"))
implementation(files("$rootDir/libs/flamingo-roboto-font-LATEST_VERSION.aar"))

  4. Call initRobotoTypography() before the first call to the FlamingoTheme

If you are an internal user

Use releases page in confluence and use flamingo-sbsans-font module instead

Playground

Flamingo Playground is a demonstration app that contains live (meaning generated using real code) demos of various design system components (see It consists of).

It can be downloaded separately here.

In addition, playground contains various debugging developer tools that facilitate painless integration and further support of the design system in your product.

To be able to use those, add the Flamingo Playground to your app:

  1. Download .aar of flamingo-playground module from the releases page

  2. Put it in /project name/libs/ folder

  3. Add this line in your staging module's build.gradle.kts:

    implementation(files("$rootDir/libs/flamingo-playground-LATEST_VERSION.aar"))
    If you are an internal user

    Use releases page in confluence

    If your project doesn't have a staging module, use build variants (not recommended):

    Example 
    android {
    // ...
    productFlavors {
        create("staging") {}
        create("production") {}
    }
}

dependencies {
    // ...
    stagingImplementation(files("$rootDir/libs/flamingo-playground-LATEST_VERSION.aar"))
}
    Groovy 
    android {
    productFlavors {
        staging {}
        production {}
    }
}

dependencies {
    // ...
    stagingImplementation(files("$rootDir/libs/flamingo-playground-LATEST_VERSION.aar"))
}

  4. Add a button to your app's debug screen that launches com.flamingo.playground.FlamingoPlaygroundActivity.

Modules Graph

graph TD;


    subgraph staging
        TRGT_APP_ST(your-app-staging);
        FL_PG(flamingo-playground);
        FL_PG_APP(flamingo-playground-app);
        FL_DEMO_API(flamingo-component-demo-api);
        TH(theater);
    end
    FONT_CHOOSER{"One of 2 modules. <br> Needed only in <br>:app module; in feature<br>modules — only if fonts<br>in XML are needed"};
    FL(flamingo);
    FL_ROBOTO(flamingo-roboto-font);
    FL_SBSANS("flamingo-sbsans-font (closed source)");
    FL_LT(flamingo-lint);
    TRGT_APP(your-app-prod);
    
    FL -- Includes lint checks --> FL_LT
    FL_LT -. "Waits for crab to complete ksp" .-> FL_PG
    FL_PG --> FL;
    FL_PG --> TH;
    FL_PG --> FL_DEMO_API;
    FL_PG_APP --> FL_PG;
    TRGT_APP --> FL;
    
    
    TRGT_APP_ST --> TRGT_APP;
    TRGT_APP_ST --> FL_PG;
    TRGT_APP_ST -- Only if you want<br>to create local UI<br>component demos --> FL_DEMO_API;
    TRGT_APP --> FONT_CHOOSER;
    FONT_CHOOSER --> FL_ROBOTO;
    FONT_CHOOSER --> FL_SBSANS;
%%    TRGT_APP_ST --> TRGT_APP;

    click TH "https://github.com/flamingo-ux/theater" _blank
    click FL "https://github.com/flamingo-ux/flamingo-android/flamingo" _blank
    click FL_PG "https://github.com/flamingo-ux/flamingo-android/flamingo-playground" _blank
    click FL_PG_APP "https://github.com/flamingo-ux/flamingo-android/flamingo-playground-app" _blank
    click FL_LT "https://github.com/flamingo-ux/flamingo-android/flamingo-lint" _blank
You might also like...
📌This repo contains the kotlin implementation of TensorflowLite Example Android Apps🚀
📌This repo contains the kotlin implementation of TensorflowLite Example Android Apps🚀

TensorflowLite Examples Kotlin This repo contains the kotlin implementation of TensorflowLite Example Apps here, which are mostly implemented in java

Sunit Roy 28 Dec 13, 2022
Kotlin implementation of WalletConnect v2 protocol for Android applications

WalletConnect V2 - Kotlin Kotlin implementation of WalletConnect v2 protocol for

WalletConnect 92 Jan 6, 2023
A Zero-Dependency Kotlin Faker implementation built to leave you fully satisfied

Satisfaketion A Zero-Dependency Kotlin Faker implementation built to leave you fully satisfied 😏 ... With your fake data How to Install 🚀 Satisfaket

Ryan Brink 7 Oct 3, 2022
Archimedes's implementation for the Java Virtual Machine (JVM)

Archimedes Give me a place to stand, and I shall move the earth. Archimedes's implementation for the Java Virtual Machine (JVM) Building From Source T

Archimedes 24 Aug 20, 2022
🗼 yukata (浴衣) is a modernized and fast GraphQL implementation made in Kotlin

🗼 yukata 浴衣 - Modernized and fast implementation of GraphQL made in Kotlin yukata is never meant to be captialised, so it'll just be yukata if you me

Noel 5 Nov 4, 2022
Saga pattern implementation in Kotlin build in top of Kotlin's Coroutines.

Module Saga Website can be found here Add in build.gradle.kts repositories { mavenCentral() } dependencies { implementation("io.github.nomisr

Simon Vergauwen 50 Dec 30, 2022
An implementation of MediatR on JVM for Spring using Kotlin coroutines

Kpring MediatR In this project, an attempt has been made to implement the mediator pattern on the JVM with simplicity using Kotlin with native corouti

Mahdi Bohloul 4 Aug 6, 2022
The RuneTopic game server implementation that hosts and processes a game world.

RuneTopic Game Server The RuneTopic game server implementation that hosts and processes a game world. Setup Guide You can host a game server with Dock

Runetopic 2 Jan 13, 2022
The RuneTopic lobby server implementation that hosts and processes a lobby.

RuneTopic Lobby Server The RuneTopic lobby server implementation that hosts and processes a lobby. Setup Guide You can host a lobby server with Docker

Runetopic 2 Dec 14, 2021
Releases(0.0.13)
Owner
Flamingo Design System
Flamingo Design System
GitHub
Android Data Managment System Android UI - Kotlin- Firebase

DataManagmentSystem Data Managment System Android UI - Kotlin- Firebase Android Data Managment System App Design And Kotlin with Firebase The project

Burak Bilici 1 Jan 29, 2022
An android app using Mongodb for logistics tracking system.

DeliveryGo An android application for logistics tracking. Used technology Kotlin: In this project kotlin is used to code the full application on Andro

Joysankar Majumdar 1 Mar 5, 2022
PlanetFacts - An educational android app for kids to learn about the planets in our solar system. Built with Kotlin.

PlanetFacts PlanetFacts is an offline simple, modern & material-designed educational Android application for kids. It contains basic facts with visual

Saikat Datta 1 Oct 16, 2022
Firestore Kotlin Client with strict (and relaxed) type-system.

Firestore Kotlin Client with strict (and relaxed) type-system.

Vihang Patil 2 Mar 4, 2022
This project is to create a system that uses DeFi technology to enforce contracts.

This project is to create a system that uses DeFi technology to enforce contracts. Users will be able to set up contracts between each other, this includes an escrow service for payments. If users disagree over whether a contract was fulfilled, a jury appointed by the system will make the final decision.

COS 301 - 2021 19 Dec 8, 2022
A command-line student management system in Kotlin

Student Management System Done as a part of NITK GSDC Android Study Jams 2021 Th

Ranjana Kambhammettu 2 Dec 24, 2021
Trawler - Trawler is a BaaS system. Backend as a service

Trawler is a BaaS system. Backend as a service. BaaS Generate REST and GraphQL f

Richard Hightower 2 Feb 9, 2022
Alternative to DreamStorageService, but instead of storing files on a database, it is stored on the file system itself.

EtherealGambi Alternative to DreamStorageService, but instead of storing files on a database, it is stored on the file system itself. I made this beca

null 1 Jun 2, 2022
Task Manager feat. real-time competitive system and user engagement

Dira Что из себя представляет Dira? Android-приложение Directa (сокр. Dira) - это планер, который способен улучшить жизнь пользователей. Он позволяет

Konstantin Albatov 4 Sep 28, 2022
📒 NotyKT is a complete 💎Kotlin-stack (Backend + Android) 📱 application built to demonstrate the use of Modern development tools with best practices implementation🦸.

NotyKT ??️ NotyKT is the complete Kotlin-stack note taking ??️ application ?? built to demonstrate a use of Kotlin programming language in server-side

Shreyas Patil 1.4k Dec 26, 2022