Skip to content

Latest commit

 

History

History
177 lines (121 loc) · 13.1 KB

README.md

File metadata and controls

177 lines (121 loc) · 13.1 KB
Raw

Twitch-Clone-Project-1200x640px

License API Build Status Stream Feeds

This is a Twitch clone app built with Stream Chat SDK for Compose to implement messaging systems and Stream Video SDK for Compose using Jetpack Compose

The purpose of this repository is to demonstrate below:

  • 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 SDK for real-time event handling.
  • Integrating video call systems with Stream Video SDK using WebRTC under the hood.

💡 Additional Repositories

If you're interested in additional repositories that were built with Jetpack Compose and Stream SDK, check out the repositories below:

  • ChatGPT Android: 📱 ChatGPT Android demonstrates OpenAI's ChatGPT on Android with Stream Chat SDK for Compose.
  • WhatsApp Clone Compose: 📱 WhatsApp clone project demonstrates modern Android development built with Jetpack Compose and Stream Chat/Video SDK for Compose.
  • Slack Clone Android: 📱 A chat demo app built with Jetpack Compose and Stream Chat SDK following clean architecture principles.
  • Stream Draw Android: 🛥 Stream Draw is a real-time multiplayer drawing & chat game app built entirely with Jetpack Compose.
  • Meeting Room Compose: 🎙️ A real-time meeting room app built with Jetpack Compose to demonstrate video communications.

📲 Download APK

Go to the Releases to download the latest APK.

📷 Previews

drawing drawing drawing
drawing drawing drawing

🛥 Stream Chat & Video SDK

Twitch Clone Compose is built with Stream Chat SDK for Compose to implement messaging systems and Stream Video SDK for Compose. If you’re interested in adding powerful In-App Messaging to your app, check out the Android Chat Messaging Tutorial or Android Video Chat Tutorial.

Stream Chat

Stream Video

💻 Build Your Own Twitch Project

If you want to build your own chat project, 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.

stream

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

stream

  1. Create a secrets.properties file on the root project directory with the text below using your API key:
STREAM_API_KEY=REPLACE WITH YOUR API KEY
  1. Build and run the project.

🛠 Tech Stack & Open Source Libraries

  • Minimum SDK level 24.
  • 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.
  • Compose Video SDK for Livestreaming: This is the official Android SDK for Stream Video, a service for building video calls, audio rooms, and live-streaming applications.
  • 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.
    • Hilt: Dependency Injection.
  • Landscapist Coil, animation, placeholder: Jetpack Compose image loading library that fetches and displays network images with Glide, Coil, and Fresco.
  • accompanist: A collection of extension libraries for Jetpack Compose
  • Retrofit2 & OkHttp3: Construct the REST APIs and paging network data.
  • Sandwich: Sandwich is an adaptable and lightweight sealed API library designed for handling API responses and exceptions in Kotlin for Retrofit, Ktor, and Kotlin Multiplatform.
  • ksp: Kotlin Symbol Processing API.
  • 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

Twitch Clone Compose follows the Google's official architecture guidance.

architecture

Twitch Clone Compose 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.

💯 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 maintainers on GitHub for our next creations! 🤩

License

Copyright 2023 Stream.IO, Inc. All Rights Reserved.

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.