https://github.com/gosunet/composebook

A compose multiplatform sample that show how you can share a component library to the web!
https://github.com/gosunet/composebook

android compose compose-android compose-multiplatform compose-web design-system kotlin kotlin-multiplatform wasm

Last synced: about 1 month ago
JSON representation

A compose multiplatform sample that show how you can share a component library to the web!

• Host: GitHub
• URL: https://github.com/gosunet/composebook
• Owner: Gosunet
• License: mit
• Created: 2023-12-07T20:41:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-02T21:04:11.000Z (2 months ago)
• Last Synced: 2024-11-02T22:17:15.447Z (2 months ago)
• Topics: android, compose, compose-android, compose-multiplatform, compose-web, design-system, kotlin, kotlin-multiplatform, wasm
• Language: Kotlin
• Homepage: https://gosunet.github.io/composebook/
• Size: 9.94 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

## Badges

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/:user)

# Composebook 🪄

This is a **Kotlin Multiplatform project** targeting Android, iOS, Web.

[Compose Multiplatform](https://www.jetbrains.com/fr-fr/lp/compose-multiplatform/) let us share compose components between mutliples targets such as Android, iOS, Desktop, etc... The new target WASM allow us to now share our component to the web!

**Composebook** is a proof of concept that show how you can use Compose multiplatform to create a **shared component library** for **Android and iOS** while letting you share this library to our beloved designers, colleagues etc with **just a [link](https://gosunet.github.io/composebook/)**. 

Removing the need to install an app to see those components! A bit like **a storybook for native app** 🙌

## Demo

https://gosunet.github.io/composebook/

## Run Locally

Clone the project

### Run your application on browser

You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task.

### Run your application on Android

- Create an Android virtual device.

- In the list of run configurations, select **composeApp**.

- Choose your Android virtual device and click **Run**.

### Run your application on iOS

- Launch Xcode in a separate window. The first time, you may also need to accept its license terms and allow it to perform some necessary initial tasks.

- In the list of run configurations, select **iosApp** and click **Run**.

- If you don't have an available iOS configuration in the list, add a new iOS simulated device.

## Authors

- [@Gosunet](https://www.github.com/Gosunet)

## Contributing

Contributions are always welcome!

## Appendix

Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),

[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),

[Kotlin/Wasm](https://kotl.in/wasm/)…