Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yacosta738/kmp-template
Kotlin Multiplatform Application project template
https://github.com/yacosta738/kmp-template
android-app android-application desktop desktop-app gradle ios ios-app kotlin kotlin-multiplatform server
Last synced: 3 days ago
JSON representation
Kotlin Multiplatform Application project template
- Host: GitHub
- URL: https://github.com/yacosta738/kmp-template
- Owner: yacosta738
- License: gpl-3.0
- Created: 2023-09-25T12:45:09.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-04-22T10:15:10.000Z (8 months ago)
- Last Synced: 2024-04-22T11:30:05.558Z (8 months ago)
- Topics: android-app, android-application, desktop, desktop-app, gradle, ios, ios-app, kotlin, kotlin-multiplatform, server
- Language: Kotlin
- Homepage: https://yacosta738.github.io/kmp-template/
- Size: 1.86 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kotlin Multiplatform Template
[![CI Build](https://github.com/yacosta738/kmp-template/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/yacosta738/kmp-template/actions/workflows/continuous-integration.yml)
[![codecov](https://codecov.io/gh/yacosta738/kmp-template/graph/badge.svg?token=A356G09B2W)](https://codecov.io/gh/yacosta738/kmp-template)
![coverage](.github/badges/jacoco.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=bugs)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=kmp-template)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=kmp-template&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=kmp-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](https://yacosta738.github.io/kmp-template/).## Setup
1. Clone this repository and change the remote to your own repository.
```bash
git clone https://github.com/yacosta738/kmp-template.git
cd
git remote set-url origin
```
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
```bash
./gradlew :app:installDebug
```
2. Run the iOS app
```bash
./gradlew :ios-app:installDebug
```
3. Run desktop app
```bash
./gradlew :desktop-app:run
```
4. Run the Server
```bash
./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.