android /sunflower

A gardening app illustrating Android development best practices with migrating a View-based app to Jetpack Compose.

★ 17,726⑂ 4,753👁 34⑃ 685● 290▤ 7
KotlinApache-2.0Created 2018-05-23d.android.com/jetpack
Download: 0.1.6 (October 11, 2018)0.1.6 ↓0.1.62018-10-11
+0
Daily
17,726
stars
4,753
forks
34
watchers
685
prs
290
issues
7
releases

README

Android Sunflower with Compose

Warning: The Sunflower repository is no longer under maintenance, We are prioritizing https://github.com/android/compose-samples as the up-to-date source of truth for Compose best practises. Please use that repository and sample set to continue learning about Jetpack Compose. If you'd like to continue using Sunflower, we encourage you to maintain your own fork of the sample. 

A gardening app illustrating Android development best practices with migrating a View-based app to
Jetpack Compose. To learn about how Sunflower was migrated to Compose, see the 
migration journey document.

 [!Note]
 To see the original View implementation of Sunflower, checkout the views branch.

 Screenshots



 Features

This sample showcases how to migrate an existing View-based app (Material 2) to Compose (Material 3). 
See the linked migration journey doc above to learn more.

 [!Note]
 As Compose cannot render HTML code in Text yet. The 
 AndroidViewBinding API is used to embed a TextView in Compose. See the 
 PlantDescription composable in the
 PlantDetailView file.

 Requirements

 Unsplash API key

Sunflower uses the Unsplash API to load pictures on the gallery
screen. To use the API, you will need to obtain a free developer API key. See the
Unsplash API Documentation for instructions.

Once you have the key, add this line to the gradle.properties file, either in your user home
directory (usually ~/.gradle/gradle.properties on Linux and Mac) or in the project's root folder:


unsplash_access_key=


The app is still usable without an API key, though you won't be able to navigate to the gallery screen.

Android Studio IDE setup
------------------------
For development, the latest version of Android Studio is required. The latest version can be
downloaded from here.

Sunflower 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

- Apply ktlint settings to Android Studio using these instructions

- Start Android Studio

Additional resources
--------------------
Check out these Wiki pages to learn more about Android Sunflower:

- Notable Community Contributions

- Publications

Non-Goals
---------
Previously, this sample app was focused on demonstrating best practices for
multiple Jetpack libraries. However, this is no longer the case and development
will instead be focused on how to adopt Compose in an existing View-based app.
So, there are no plans to implement features outside of this scope. Keep this
in mind when making contributions to this library.

Support
-------

- Stack Overflow:
  - https://stackoverflow.com/questions/tagged/android-jetpack-compose

If you've found an error in this sample, please file an issue:
https://github.com/android/sunflower/issues

Patches are encouraged, and may be submitted by forking this project and submitting a 

Top issues

Latest release

0.1.6 (October 11, 2018) 0.1.6 2018-10-11
This release adds and updates databinding for various Fragments, converts the project to use AndroidX, and adds an app icon.  It also includes many library updates and minor code and text fixes.

Note: this is the last versioned release.  From this point onward, issues and PRs will not be tied to a milestone or release.

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON