https://github.com/telereso/kmp-core
Core classes and tools while developing kmp projects
https://github.com/telereso/kmp-core
hacktoberfest kotlin kotlin-multiplatform
Last synced: 28 days ago
JSON representation
Core classes and tools while developing kmp projects
- Host: GitHub
- URL: https://github.com/telereso/kmp-core
- Owner: telereso
- License: mit
- Created: 2023-01-18T02:41:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:22:00.000Z (6 months ago)
- Last Synced: 2024-10-30T01:51:14.335Z (6 months ago)
- Topics: hacktoberfest, kotlin, kotlin-multiplatform
- Language: Kotlin
- Homepage: https://kmp.telereso.io/core
- Size: 1.7 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Core
[](https://telereso.github.io/kmp-core/tests/kover)
# Docs
Each version has it's docs , you can check the latest docs by providing the latest `` to the follwoing url
`https://telereso.github.io/kmp-core/docs/core//index.html`
The latest version is
[](https://github.com/telereso/kmp-core/releases)
For example to get docs for version 0.0.4 you can visiting
https://telereso.github.io/kmp-core/docs/core/0.0.4/index.html
# Setup
The following are the first commands to init all the project examples
## Android
Click run `androidApp` will open the android example
## iOS
Run the following command
```shell
cd iosApp && pod install && cd ..
```
Then Open `iosApp` in Xcode or AppScript, and click run button will open ios example
## Web
Run the following command
```shell
cd webApp && yarn && yarn serve
```
Then open `webApp` in intellij Idea or VSCode and check `README.md` file
## ReactNative
Run the following command
```shell
cd react-native-core-client && yarn && yarn bootstrap && yarn example android && yarn example ios
```
then open `react-native-core-client` in intellij Idea or VSCode and check `README.md` file
# Unit Test
## All Tetes
```shell
./gradlew allTests
```
## iOS
```shell
./gradlew iosSimulatorArm64Test
```
## Coverage
```shell
./gradlew koverHtmlReport
```
For more details about contributing check [CONTRIBUTING page](https://github.com/telereso/kmp-core/blob/main/CONTRIBUTING.md)
## Website
Serve
```shell
cd website && bundle exec jekyll serve website && cd ..
```
# Publish
The pipeline will take care of publishing the library when merging to `main`
## Locally
to publish to local maven run this command
```shell
bash scripts/publish.sh 0.0.13
```
The output version will be `0.0.13-local` and you can use it like this
```kotlin
dependencies {
api("io.telereso.kmp:core:0.0.13-local")
}
```