Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikepenz/storyblok-mp-sdk-sample
Storyblok Kotlin Multiplatform SDK sample (Android, JVM, JS)
https://github.com/mikepenz/storyblok-mp-sdk-sample
android jetpack-compose kotlin kotlin-multiplatform storyblok
Last synced: 3 months ago
JSON representation
Storyblok Kotlin Multiplatform SDK sample (Android, JVM, JS)
- Host: GitHub
- URL: https://github.com/mikepenz/storyblok-mp-sdk-sample
- Owner: mikepenz
- License: apache-2.0
- Created: 2021-09-17T17:52:27.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2021-09-17T18:34:48.000Z (over 3 years ago)
- Last Synced: 2024-05-02T01:09:29.087Z (9 months ago)
- Topics: android, jetpack-compose, kotlin, kotlin-multiplatform, storyblok
- Language: Kotlin
- Homepage:
- Size: 288 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
storyblok-mp-SDK-sample *WIP*
... a showcase of the Storyblok Kotlin Multiplatform Client SDK. (Android, JVM, JS, iOS, ...)-------
What's included 🚀 •
About Storyblok •
Building 🛠️ •
Credits •
License 📓-------
### What's included 🚀
Minimal **Kotlin Multiplatform** project showcasing the [Storyblok Kotlin Multiplatform SDK](https://github.com/mikepenz/storyblok-mp-SDK). Currently running on
* Android (Jetpack Compose)
* Wear OS (Jetpack Compose)
* Desktop (Compose for Desktop)
* Web (Compose for Web)
* Web (Kotlin/JS + React Wrapper)-------
## About Storyblok
- **WEBSITE** https://www.storyblok.com/
- **API DOC** https://www.storyblok.com/docs/api/content-delivery/v2-------
## Building
You need to use Android Studio Arctic Fox (**note: Java 11 is now the minimum version required**).
Before executing the samples you have to replace `YOUR_STORYBLOK_TOKEN` with your Storyblok token inside the `gradle.properties`.
Android / Wear app
Run the Android app or WearOS app via Android Studio.
React web client
```bash
./gradlew :web:browserDevelopmentRun
```Compose for Web client
The Compose for Web client resides in the `compose-web` module and can be run by invoking:
```bash
./gradlew :compose-web:jsBrowserDevelopmentRun
```Compose for Desktop client
This client is available in `compose-desktop` module. Note that you need to use appropriate version of JVM when running (works for example with Java 11)
```bash
./gradlew :compose-desktop:run
```## Credits
This project is heavily based on the amazing [PeopleInSpace](https://github.com/joreilly/PeopleInSpace) sample by @joreilly
## Maintained By
* Mike Penz
* [mikepenz.com](http://mikepenz.com) -
* [paypal.me/mikepenz](http://paypal.me/mikepenz)## License
Copyright 2021 Mike Penz
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.