Kicks
Kicks is a simple music streaming app built with Kotlin Multiplatform Mobile and Compose Multiplatform
How does it work?
It streams free audio medias; from Pixabay. The app uses expect/actual to delegate the AudioPlayer to both platforms using AVPlayer on iOS and Media3 on Android.
📱 Sneak peak
Screenshots
▶️ Android
kicks_vid.mp4
▶️ iOS
kicks_ios.rc.mp4
Built with
- Kotlin: Programming language
- Kotlin/Native: Kotin Native interop with Objective-C
- Kotlin Multiplatform: For building multi-platform applications in the single codebase.
- Compose Multiplatform: For a shared UI between Android and iOS.
- AVPlayer: Foundation Media player library for iOS
- Media3: Exoplayer based Media player library for Android
- UI Design: design for the UI.
TODOs
Currently, this is a one screen app, showing playlist and controls. More work to be done.
âś… Completed
- Playlist and controls UI
- Basic controls play/pause/next/prev
- Auto next
- Seek
- Current duration
- Auto scroll if currently played item is hidden
🚧 To be done
- Full player screen
- Background play
- Player notification
- Maybe a library out off all this.
Setting up project 👨🏻‍💻
- Refer to the “Setting up environment” section of this repository for knowing the setup guidelines
- After validating requirements as per the above guide, clone this repository.
- Open this project in Android Studio Electric Eel or newer version.
- Build project 🔨 and see if everything is working fine.
- Run App
- Select “androidApp” as run configuration and you’ll be able to run the Android app.
- Select “iosApp” as run configuration and you’ll be able to run the iOS app (XCode can also be used to run the app).
Project structure
This Compose Multiplatform project includes three modules:
shared
This is a Kotlin module that contains the logic common for both Android and iOS applications, the code you share between platforms. This shared module is also where you write your Compose Multiplatform code. In shared/src/commonMain/kotlin/App.kt, you can find the shared root @Composable function for your app. It uses Gradle as the build system. You can add dependencies and change settings in shared/build.gradle.kts. The shared module builds into an Android library and an iOS framework.
android
This is a Kotlin module that builds into an Android application. It uses Gradle as the build system. The androidApp module depends on and uses the shared module as a regular Android library.
ios
This is an Xcode project that builds into an iOS application. It depends on and uses the shared module as a CocoaPods dependency.
Contribute
Feel free to fork and open a pull request.
Acknowledgements
- JetBrains/compose-multiplatform-ios-android-template: For Starter template
- Fooduim-Kmm: For an awesome readme template.
License
Copyright 2023 Ayodele Kehinde
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.