Ismail BENABDALLAH
726bacf1c1
|
10 months ago | |
---|---|---|
.. | ||
composeApp | 10 months ago | |
gradle | 10 months ago | |
iosApp | 10 months ago | |
screenshots | 10 months ago | |
.gitignore | 10 months ago | |
LICENSE | 10 months ago | |
README.md | 10 months ago | |
build.gradle.kts | 10 months ago | |
gradle.properties | 10 months ago | |
gradlew | 10 months ago | |
gradlew.bat | 10 months ago | |
settings.gradle.kts | 10 months ago |
README.md
Indicators Compose Multiplatform
This is a sample project that demonstrates the use of the Compose Multiplatform UI framework with Kotlin Multiplatform (KMP), targeting Android and iOS. The application displays a pager with a progress indicator in the pages.
Screenshots (Android & iOS)
First Android | Second Android | Third Android |
---|---|---|
First iOS | Second iOS | Third iOS |
---|---|---|
Demo
Prerequisites
To run this project, you'll need the following:
Getting Started
-
Clone this repository to your local machine.
git clone https://github.com/ibenabdallah/indicators-compose-multiplatform.git
-
Open the project in Android Studio.
-
Set up your Android and iOS device/emulator/simulator.
-
Build and run the project.
Project Structure
The project follows the standard Kotlin Multiplatform (KMP) structure, with the following notable files and directories:
-
composeApp
: Contains the Android project configuration.src/commonMain
: Contains the common code, including the Compose-based UI implementation.src/androidMain
: Contains the Android-specific code and specific configuration files.src/iosMain
: Contains the iOS-specific code.
-
iosApp
: Contains the iOS-specific configuration files. -
build.gradle.kts
: The main Gradle build script for the project.
Run project on Different Platforms 🚀
Android
To run the application on android device/emulator:
- open project in Android Studio and run imported android run configuration
To build the application bundle:
- run
./gradlew :composeApp:assembleDebug
- find
.apk
file incomposeApp/build/outputs/apk/debug/composeApp-debug.apk
iOS
To run the application on iPhone device/simulator:
- Open
iosApp/iosApp.xcproject
in Xcode and run standard configuration - Or use Kotlin Multiplatform Mobile plugin for Android Studio
Resources
This project is based on the concepts and frameworks provided by Kotlin Multiplatform Mobile (KMM), Jetpack Compose, and Compose Multiplatform. Here are some resources that might be helpful in learning more about Compose Multiplatform UI and KMM
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. Please ensure that your contributions adhere to the project's coding style and guidelines.
Contributors 📢
License
This project is licensed under the MIT License.