# sunflower

**Repository Path**: hzj1444/sunflower

## Basic Information

- **Project Name**: sunflower
- **Description**: 技术栈：
Kotlin：Sunflower 使用 Kotlin 作为主要编程语言。
Jetpack 组件：包括 Room、ViewModel、LiveData、Navigation 等 Jetpack 组件，用于简化开发过程、提高应用性能和可维护性。
Retrofit：用于进行网络请求和访问 RESTful API。
Glide：用于加载和展示图片。
Material Design：遵循 设计原则
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-09-22
- **Last Updated**: 2024-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


Sunflower 是一个 Android 官方提供的开源项目，它旨在展示通过 Jetpack 组件进行 Android 应用开发的最佳实践。下面是 Sunflower 项目的技术栈、开发流程、框架和架构的简要描述：

技术栈：
1. Kotlin：Sunflower 使用 Kotlin 作为主要编程语言。
2. Jetpack 组件：包括 Room、ViewModel、LiveData、Navigation 等 Jetpack 组件，用于简化开发过程、提高应用性能和可维护性。
3. Retrofit：用于进行网络请求和访问 RESTful API。
4. Glide：用于加载和展示图片。
5. Material Design：遵循 Material Design 设计原则，提供流畅的界面和用户体验。

开发流程：
1. 需求分析：明确项目目标和功能需求，对于 Sunflower 项目而言，它主要展示如何使用 Jetpack 组件进行 Android 开发。
2. 架构设计：根据项目需求，选择适合的架构模式，如 MVVM，以及确定使用的 Jetpack 组件。
3. 编码实现：根据需求和架构设计，使用 Kotlin 编写代码实现功能。
4. 单元测试和集成测试：编写测试用例，确保代码的正确性和稳定性。
5. 调试和优化：通过调试和性能分析工具，识别和解决可能存在的问题，提高应用的性能和响应速度。
6. 发布和迭代：将应用打包发布到应用商店，并根据用户反馈和需求进行持续迭代和更新。

框架和架构：
1. 架构模式：Sunflower 使用了 MVVM（Model-View-ViewModel）架构模式，将业务逻辑与界面逻辑分离，提供更好的可测试性和可维护性。
2. Jetpack 组件：Sunflower 使用了一系列 Jetpack 组件，如 Room（持久化层）、ViewModel（管理 UI 相关数据）、LiveData（在组件之间共享数据）和 Navigation（导航组件）等，这些组件帮助开发人员简化开发过程，提高应用质量。
3. 分层结构：Sunflower 采用了典型的分层结构，将数据访问层、业务逻辑层和界面层分离，提供了更清晰的代码结构和开发流程。

# Android Sunflower with Compose

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](https://github.com/android/sunflower/blob/main/docs/MigrationJourney.md) document.

**Note**: To see the original View implementation of Sunflower, checkout the [`views`](https://github.com/android/sunflower/tree/views) branch.

## Screenshots

<img src="screenshots/SunflowerM3Screenshots.png"/>

## 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](app/src/main/java/com/google/samples/apps/sunflower/compose/plantdetail/PlantDetailView.kt).

## Requirements

### Unsplash API key

Sunflower uses the [Unsplash API](https://unsplash.com/developers) 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](https://unsplash.com/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=<your 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](https://developer.android.com/studio/).

Sunflower uses [ktlint](https://ktlint.github.io/) to enforce Kotlin coding styles.
Here's how to configure it for use with Android Studio (instructions adapted
from the ktlint [README](https://github.com/shyiko/ktlint/blob/master/README.md)):

- Close Android Studio if it's open

- Download ktlint using these [installation instructions](https://github.com/pinterest/ktlint/blob/master/README.md#installation)

- Apply ktlint settings to Android Studio using these [instructions](https://github.com/pinterest/ktlint/blob/master/README.md#-with-intellij-idea)

- Start Android Studio

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

- [Notable Community Contributions](https://github.com/android/sunflower/wiki/Notable-Community-Contributions)

- [Publications](https://github.com/android/sunflower/wiki/Sunflower-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 pull request
through GitHub.

Third Party Content
-------------------
Select text used for describing the plants (in `plants.json`) are used from Wikipedia via CC BY-SA 3.0 US (license in `ASSETS_LICENSE`).

"[seed](https://thenounproject.com/search/?q=seed&i=1585971)" by [Aisyah](https://thenounproject.com/aisyahalmasyira/) is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode)