/gemini-android

✨ Gemini Android demonstrates Google's Generative AI on Android with Stream Chat SDK for Compose.

Primary LanguageKotlinApache License 2.0Apache-2.0

Gemini Cover

License API Build Status Profile

Gemini Android demonstrates Google's Generative AI on Android with Stream Chat SDK for Compose.

The purpose of this repository is to demonstrate below:

  • Demonstrates Gemini API for Android.
  • Implementing entire UI elements with Jetpack Compose.
  • Implementation of Android architecture components with Jetpack libraries such as Hilt and AppStartup.
  • Performing background tasks with Kotlin Coroutines.
  • Integrating chat systems with Stream Chat Compose SDK for real-time event handling.

📷 Previews

drawing drawing drawing

🛥 Stream Chat & Video SDK

Gemini Android is built with Stream Chat SDK for Compose to implement messaging systems. If you’re interested in building powerful real-time video/audio calling, audio room, and livestreaming, check out the Stream Video SDK for Compose!

Stream Chat

Stream Video

💻 How to build the project?

To build this project properly, you should follow the instructions below:

  1. Go to the Stream login page.
  2. If you have your GitHub account, click the SIGN UP WITH GITHUB button and you can sign up within a couple of seconds.

stream

  1. If you don't have a GitHub account, fill in the inputs and click the START FREE TRIAL button.
  2. Go to the Dashboard and click the Create App button like the below.

stream

  1. Fill in the blanks like the below and click the Create App button.

  1. You will see the Key like the image below and then copy it.

stream

  1. Create a new file named secrets.properties on the root directory of this Android project, and add the key to the secrets.properties file like the below:

stream

STREAM_API_KEY=..

  1. Go to your Dashboard again and click your App.

  2. In the Overview menu, you can find the Authentication category by scrolling to the middle of the page.

  3. Switch on the Disable Auth Checks option and click the Submit button like the image below.

stream

  1. Click the Explorer tab on the left side menu.

  2. Click users -> Create New User button sequentially and add fill in the user like the below:

  • User Name: gemini
  • User ID: gemini
  1. Go to Google AI Studio, login with your Google account and select the Get API key on the menu left like the image below:

gemini

  1. Create your API key for using generative AI SDKs, and you'll get one like the image below:

gemini

  1. Add the key to the secrets.properties file like the below:

gemini

GEMINI_API_KEY=..
  1. Build and run the project.

🛠 Tech Stack & Open Source Libraries

  • Minimum SDK level 21.
  • 100% Jetpack Compose based + Coroutines + Flow for asynchronous.
  • Compose Chat SDK for Messaging: The Jetpack Compose Chat Messaging SDK is built on a low-level chat client and provides modular, customizable Compose UI components that you can easily drop into your app.
  • Jetpack
    • Compose: Android’s modern toolkit for building native UI.
    • ViewModel: UI related data holder and lifecycle aware.
    • App Startup: Provides a straightforward, performant way to initialize components at application startup.
    • Navigation: For navigating screens and Hilt Navigation Compose for injecting dependencies.
    • Room: Constructs Database by providing an abstraction layer over SQLite to allow fluent database access.
    • Datastore: Store data asynchronously, consistently, and transactionally, overcoming some of the drawbacks of SharedPreferences.
    • Hilt: Dependency Injection.
  • Landscapist Glide, animation, placeholder: Jetpack Compose image loading library that fetches and displays network images with Glide, Coil, and Fresco.
  • Retrofit2 & OkHttp3: Construct the REST APIs and paging network data.
  • Sandwich: Construct a lightweight and modern response interface to handle network payload for Android.
  • Moshi: A modern JSON library for Kotlin and Java.
  • ksp: Kotlin Symbol Processing API.
  • Balloon: Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android.
  • StreamLog: A lightweight and extensible logger library for Kotlin and Android.
  • Baseline Profiles: To improve app performance by including a list of classes and methods specifications in your APK that can be used by Android Runtime.

🏛️ Architecture

Gemini Android follows the Google's official architecture guidance.

architecture

Gemini Android was built with Guide to app architecture, so it would be a great sample to show how the architecture works in real-world projects.

The overall architecture is composed of two layers; UI Layer and the data layer. Each layer has dedicated components and they each have different responsibilities. The arrow means the component has a dependency on the target component following its direction.

Architecture Overview

layer

Each layer has different responsibilities below. Basically, they follow unidirectional event/data flow.

UI Layer

layer

The UI Layer consists of UI elements like buttons, menus, tabs that could interact with users and ViewModel that holds app states and restores data when configuration changes.

Data Layer

layer

The data Layer consists of repositories, which include business logic, such as querying data from the local database and requesting remote data from the network. It is implemented as an offline-first source of business logic and follows the single source of truth principle.

For more information about the overall architecture, check out Build a Real-Time WhatsApp Clone With Jetpack Compose.

Modularization

Gemini Android has implemented the following modularization strategies:

  • Reusability: By effectively modularizing reusable code, it not only facilitates code sharing but also restricts code access across different modules.

  • Parallel Building: Modules are capable of being built in parallel, leading to reduced overall build time.

  • Decentralized Focusing: Individual development teams are allocated specific modules, allowing them to concentrate on their designated areas.

💯 MAD Score

summary

🤝 Contribution

Most of the features are not completed except the chat feature, so anyone can contribute and improve this project following the Contributing Guideline.

Find this repository useful? 💙

Support it by joining stargazers for this repository. ⭐
Also, follow me on GitHub for my next creations! 🤩

License

Designed and developed by 2024 skydoves (Jaewoong Eum)

Licensed 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.