https://github.com/shubhanshu24510/social-twitch
A platform that users can use for their social media stuff - like posting, messaging and connecting with friends easily.
https://github.com/shubhanshu24510/social-twitch
jetpack-compose koin-android kotlin ktor-framework nativeapps socialapp
Last synced: 3 months ago
JSON representation
A platform that users can use for their social media stuff - like posting, messaging and connecting with friends easily.
- Host: GitHub
- URL: https://github.com/shubhanshu24510/social-twitch
- Owner: shubhanshu24510
- Created: 2024-01-08T19:48:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-18T06:58:42.000Z (3 months ago)
- Last Synced: 2025-02-24T05:39:53.920Z (3 months ago)
- Topics: jetpack-compose, koin-android, kotlin, ktor-framework, nativeapps, socialapp
- Language: Kotlin
- Homepage:
- Size: 2.39 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Social Twitch
🗡️Social Twitch with features like chat, posting, messaging, and friend connections, demonstrates modern Android development with Jetpack Compose, Hilt, Ktor, Coroutines, Flow, Jetpack (Room, ViewModel), and Material Design based on MVVM architecture.
## 📷 Previews
### Key Features:
- Responsive UI
- Native Android App
- Material Design Components
- Comprehensive Search
-Auth Features Login and Sign Up
-Channel Home
-Chat Message Stuff
- Like and Comment Features
-Search friends Stuff
- Navigation Rail for Foldable Devices
-Post picture features
### Languages, libraries and tools used
* [Kotlin](https://kotlinlang.org/)
* [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* [Kotlinx Serialization](https://github.com/Kotlin/kotlinx.serialization)
* [Ktor client library](https://github.com/ktorio/ktor)
* [Kotlin Coroutine](https://github.com/Kotlin/kotlinx.coroutines)
* [Dagger-Hilt](https://developer.android.com/training/dependency-injection/hilt-android)
* [Retrofit](https://square.github.io/retrofit/)
* [Scarlet](https://github.com/Tinder/Scarlet)
* [KMongo](https://litote.org/kmongo/quick-start/)
* [Ktor](https://ktor.io/docs/client-dependencies.html)
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html)
* [Koin](https://github.com/InsertKoinIO/koin)
* [Jetpack Compose](https://developer.android.com/jetpack/compose)
* [Coil](https://coil-kt.github.io/coil/)
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
**Social Clone** adheres to the MVVM architecture and implements the Repository pattern, aligning with [Google's official architecture guidance](https://developer.android.com/topic/architecture).
The architecture of **Pokedex Jetpack** is structured into two distinct layers: the UI layer and the data layer. Each layer fulfills specific roles and responsibilities, outlined as follows:
**Social Clone** follows the principles outlined in the [Guide to app architecture](https://developer.android.com/topic/architecture), making it an exemplary demonstration of architectural concepts in practical application.
### Architecture Overview
- Each layer adheres to the principles of [unidirectional event/data flow](https://developer.android.com/topic/architecture/ui-layer#udf): the UI layer sends user events to the data layer, and the data layer provides data streams to other layers.
- The data layer operates autonomously from other layers, maintaining purity without dependencies on external layers.
This loosely coupled architecture enhances component reusability and app scalability, facilitating seamless development and maintenance.
### UI Layer
The UI layer encompasses UI elements responsible for configuring screens for user interaction, alongside the [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel), which manages app states and restores data during configuration changes.
- UI elements observe the data flow, ensuring synchronization with the underlying data layer.
### Data Layer
The data layer is composed of repositories that handle business logic tasks such as retrieving data from a local database or fetching remote data from a network. This layer is designed to prioritize offline access, functioning primarily as an offline-first repository of business logic. It adheres to the principle of "single source of truth," ensuring that all data operations are centralized and consistent.
**Pokedex Compose** is an offline-first app, meaning it can perform all or most of its essential functions without an internet connection. This design allows users to access core features reliably, regardless of network availability, reducing their need for constant updates and decreasing data usage. For more details on how to build an offline-first application, you can visit [Build an offline-first app](https://developer.android.com/topic/architecture/data-layer/offline-first).
## Modularization
**Social Clone** adopted modularization strategies below:
- **Reusability**: Modulizing reusable codes properly enable opportunities for code sharing and limits code accessibility in other modules at the same time.
- **Parallel Building**: Each module can be run in parallel and it reduces the build time.
- **Strict visibility control**: Modules restrict to expose dedicated components and access to other layers, so it prevents they're being used outside the module
- **Decentralized focusing**: Each developer team can assign their dedicated module and they can focus on their own modules.
For more information, check out the [Guide to Android app modularization](https://developer.android.com/topic/modularization).