Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holdbetter/PremierLeague
Full-stack application built with Kotlin Multiplatform (KMP) that offers live result updates across Premier League
https://github.com/holdbetter/PremierLeague
android backend clean-architecture figma kmm kotlin kotlin-multiplatform kotlin-multiplatform-mobile ktor multimodule user-interface
Last synced: about 2 months ago
JSON representation
Full-stack application built with Kotlin Multiplatform (KMP) that offers live result updates across Premier League
- Host: GitHub
- URL: https://github.com/holdbetter/PremierLeague
- Owner: holdbetter
- Created: 2023-02-03T13:41:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T20:57:51.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:26:41.063Z (4 months ago)
- Topics: android, backend, clean-architecture, figma, kmm, kotlin, kotlin-multiplatform, kotlin-multiplatform-mobile, ktor, multimodule, user-interface
- Language: Kotlin
- Homepage:
- Size: 376 KB
- Stars: 19
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-kotlin-multiplatform - PremierLeague
README
#  Premier League: standings, scores, teams
An open-source full-stack application with English football league scores built with Kotlin Multiplatform (KMP)
### DISCLAIMER
App is online. Season 2023/2024 has started. Developing is on pause, not enough free time for adding new features. Only support
### Stack
š¬ Backend: Ktor (Server) + Flow/Coroutines (Network) + Ktor (Network) + Kodein (DI) + Exposed (ORM) + PostgreSQL (DB) + kotlinx.serialization (Data)
š§± Multiplatform: Custom Simple MVI (Model-View-Intent, inspired by arkivanov), Flow/Coroutines, Clean- Architecture ([What?](https://github.com/holdbetter/PremierLeague/tree/main#clean-)), Ktor + Abstraction (Network), DI.kt (DI), Napier (Logging), Deeplink Navigation, Local databases
š± Android: Palette (Colors) + Glide + Room with ksp + Dynamic Navigation Component on routes + DI.kt (DI) + Coroutines/Flow + ViewBinding (xml) and bunch of custom views
šØ Figma: Components + Themes + Prototypes
Also, you can just open `Deps.kt` file, but consider there are some unused constants (e.g MVICore, Iām not using it for now)
### Tech features
- Multiplatform abstractions at network, database, navigation, UI, DI layers
- Automatically colored UI based on team logo colors with custom adjusting on UI components demand
- Light and Dark theme are supported
- Module separation: core and feature module scheme
- Only cross-platform libraries / dependencies
### User features
- Check standings
- Add your favorites
- Discover teams twitter
- Watch live scores
- Team matches calendar
- Explore history at current season
### Demonstration and access
[Download apk](https://drive.google.com/file/d/1slZFDtRe3QMZI1i6tcjgce4gGQymuq7b/view?usp=sharing)
[Watch demo](https://drive.google.com/file/d/1AKfiUJE2AHi7hqUM2WzLDsO2P_rV8qVO/view?usp=share_link)
### Credits
Hey, my name is Vilen.
I am Android developer with 5+ year programming experience. I am passionate about UI/UX design and enjoy trying new things. This project expresses me well š
I am going to probably publish this app in Play Market for the next football season, but it mainly developed for educational purposes. If you are interested to see it in Play Market follow to roadmap.
You are welcome for asking any questions about the project!
[Contact](https://t.me/holdbetter)
### Design
[Figma](https://www.figma.com/file/63yqz3bw0qT4JouWrvfqJo/League2023-(Share)?node-id=0%3A1&t=xo6iBPGClRK1VWss-1)
### Roadmap: Features
- [ ] Compare feature
- [ ] Live notifications
- [ ] Team subscriptions
- [ ] ~~Publishing (August 2023)~~ not planned for now
### Roadmap: Tech
- [ ] Multiplatform test coverage
- [ ] Analytics
- [ ] Connectivity-aware
- [ ] Backend authentication
- [ ] K2 migration
- [ ] MVICore branch
- [ ] Android Compose branch
- [ ] Decompose branch
- [ ] Compose Multiplatform
- [ ] Web client (2024)
- [ ] iOS client - SwiftUI or Compose (2024)
## Architecture
This chapter describes how the project is designed and explains how the main multiplatform features are implemented.
### About
The project uses multimodule structure not only because it's KMM (Kotlin Multimodule). Itās like āmicroservicesā - if you are not familiar with multimodule term.
All modules except `androidApp` and `backend` are KMM shared modules. Backend is JVM module with Ktor Server on board. AndroidApp is an application module of Android platform.
Any *-example module is independent android application which exposes one feature to play with.
The project itself working with gradle `kotlin-dsl` plugin, so there is `buildSrc` module, it resolves dependencies across modules.
### Modules
Iām using feature-separated structure. Communication between modules expressed in the chart below, also you can explore it with [Lucidchart](https://lucid.app/documents/view/3104509a-6501-44e6-9678-c67e7130fd07):
Big image chart:
### Clean-
Iām aware of Clean architecture, but it doesnāt fit well with modern approaches since it adds a lot of boilerplate. I do use it, but not the way it was introduced.
For example, things like RxJava and Flow changed the way you communicate between Clean layers. Also I am avoiding use-cases, because my project mostly has `Repository` with one method and I prefer keep it simple.
As a result I donāt call it āClean architurectureā even if I am applying itās rules.
### Network (Shared Business Logic Example)
As you could see `core-network` module is shared module and it consists of 4 modules: common - contains shared code and others are platform-specific modules: Android, iOS, JVM. The last is using by backend service. So all project parts (even backend) consume same module, same logic and same API.
Iāve designed 2 UML diagrams which describe communication between entities.
First illustrates how platform-specific parts are implemented and how DI would provide it to feature-modules. If it seems hard to investigate please follow to second diagram.
Multiplatform Shared Network Logic Implementation: [(pdf)](https://drive.google.com/file/d/1D-e0a82YKKUSuwUjkkrLNCJciqb0w0Ym/view?usp=share_link)
Another big image chart:
The second diagram shows how feature module consumes network module. At the diagram, feature module is common module, it defines business logic with repository to receive data from network or database and return it to UI.
Although common module isnāt platform specific it provides repository to the presentation layer. Presentation (UI) is platform-specific so features common module implicitly exposes implementation code thatās why `android-network` presented on chart.
Multiplatform Shared Network Logic Usage: [(pdf)](https://drive.google.com/file/d/1D-e0a82YKKUSuwUjkkrLNCJciqb0w0Ym/view?usp=share_link)
### Build and Run
#### Backend
******Run******
To build and run backend service you need prerequisites an API key and PostgreSQL database. You can it do it locally. If you set up it correctly, then run following command with terminal at the project root folder:
`./gradlew backend:run`
**********Debug**********
Alternatively, run gradle command in Android Studio to create configuration and debug it after
#### Other
Android app and feature example configs runs as it is from āRun configurationsā menu, no additional steps required
### p.s What project isnāt about?
Iām focused on new things, so if I had experience in some topic before, Iāll drop it down of my list. Thatās why clients are not connectivity-aware now; It doesnāt have retry policy, exception handling or any stuff like that. If you are reading this for hiring purposes or whatever you need to see more safe app examples please check out [this](https://github.com/holdbetter/FintechChatty) project and itās sustainability demo