Kotlin Multiplatform Template

This is a template for a Kotlin Multiplatform project. It is configured to build a library for Android, iOS, and the JVM. It also includes a sample Android app and a sample iOS app.

Documentation

The documentation for this project is available at https://yacosta738.github.io/kmp-template.

Setup

1. Clone this repository and change the remote to your own repository.

git clone https://github.com/yacosta738/kmp-template.git <your-project-name>
cd <your-project-name>
git remote set-url origin <your-repository-url>

2. Update the project name in settings.gradle.kts.
3. Update the package name of the all modules.
4. Update the project name in README.md.

Starting running the project locally

1. Run the Android app

./gradlew :app:installDebug

2. Run the iOS app

./gradlew :ios-app:installDebug

3. Run desktop app

./gradlew :desktop-app:run

4. Run the Server

./gradlew :server:run

CI/CD

This project uses GitHub Actions for CI/CD. The workflow is defined in .github/workflows/continuous-integration.yml. It is configured to run the tests, build the apps, and publish the artifacts to GitHub Packages.