Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ioki-mobility/kmp-lokalise-api
Lokalise API v2 Kotlin Multiplatform client library.
https://github.com/ioki-mobility/kmp-lokalise-api
hacktoberfest kotlin-multiplatform lokalise-api
Last synced: about 1 month ago
JSON representation
Lokalise API v2 Kotlin Multiplatform client library.
- Host: GitHub
- URL: https://github.com/ioki-mobility/kmp-lokalise-api
- Owner: ioki-mobility
- License: mit
- Created: 2023-09-08T10:30:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T13:04:52.000Z (8 months ago)
- Last Synced: 2024-05-29T03:42:37.360Z (8 months ago)
- Topics: hacktoberfest, kotlin-multiplatform, lokalise-api
- Language: Kotlin
- Homepage: https://developers.lokalise.com/reference/lokalise-rest-api
- Size: 213 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lokalise API v2 unofficial KMP client library
[](https://github.com/ioki-mobility/kmp-lokalise-api/actions/workflows/tests.yml)
[](https://central.sonatype.com/artifact/com.ioki/lokalise-api)
[](https://s01.oss.sonatype.org/content/repositories/snapshots/com/ioki/)
[](https://javadoc.io/doc/com.ioki/lokalise-api)
[](https://github.com/ioki-mobility/kmp-lokalise-api/blob/master/LICENSE.md)
Inofficial Kotlin Multiplatform implementation of the [Lokalise API](https://developers.lokalise.com/reference/lokalise-rest-api)
targeting `JVM`, `macOS/X64`, `macOS/Arm64`, `Mingw(Windows)/X64` and `Linux/X64`.
## What?
As we needed an JVM implementation of the Lokalise API in one of our projects
but didn't find one, we decided to build our own based on KMP.
Even though we focus on JVM
the other targets has the same priority as the JVM implementation.
## How?
All you need to do is to create an Lokalise API token to create a `Lokalise` instance:
```kotlin
val lokaliseClient = Lokalise("[API_TOKEN]")
```
Optional, you can set `fullLoggingEnabled` to `true` to enable logging for
the HTTP communication.
## Download
### Add the repository
The project is hosted on Maven Central.
```kotlin
repositories {
mavenCentral()
}
```
### Add the dependency
```kotlin
dependencies {
implementation("com.ioki:lokalise-api:")
}
```
## Release
### Continuous release
By default, each merge to `main` will create a new `SNAPSHOT` release.
If you want to use the latest and greatest use the `SNAPSHOT` version of the library.
But please be aware that they might contain bugs or behaviour changes.
To use the SNAPSHOT version you have to include the sonatype snapshot repository:
```kotlin
repositories {
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
dependencies {
implementation("com.ioki:lokalise-api:-SNAPSHOT")
}
```
### Proper release
* Checkout `main`
* Pull latest changes
* Adjust version in [`build.gradle.kts`](build.gradle.kts) to a non-SNAPSHOT version
* Commit `Prepare next release`
* Create a git tag that has the exact name as the version you just modified in the `build.gradle.kts` file.
* Push the `tag`
* Increase the `version` to the next **minor** version +`-SNAPSHOT` (e.g. `0.0.2-SNAPSHOT`) in the [`build.gradle.kts`](build.gradle.kts) file
* Commit `Prepare for next version`
* Push to `main`
* Create a [GitHub release](https://github.com/ioki-mobility/kmp-lokalise-api/releases)
> **Note**: The `tag` push will create a new release with the [`Publish` workflow](https://github.com/ioki-mobility/kmp-lokalise-api/actions/workflows/publish.yml).