|
1 |
| -This is a Kotlin Multiplatform project targeting Android, iOS, Web. |
2 | 1 |
|
3 |
| -* `/composeApp` is for code that will be shared across your Compose Multiplatform applications. |
4 |
| - It contains several subfolders: |
5 |
| - - `commonMain` is for code that’s common for all targets. |
6 |
| - - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. |
7 |
| - For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, |
8 |
| - `iosMain` would be the right folder for such calls. |
| 2 | +## Badges |
9 | 3 |
|
10 |
| -* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, |
11 |
| - you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project. |
| 4 | +[](https://choosealicense.com/licenses/mit/) |
| 5 | + |
12 | 6 |
|
13 | 7 |
|
| 8 | +# Composebook 🪄 |
| 9 | + |
| 10 | +This is a **Kotlin Multiplatform project** targeting Android, iOS, Web. |
| 11 | + |
| 12 | +[Jetpack 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! |
| 13 | + |
| 14 | +**Composebook** is a proof of concept that show how you can use jetpack compose multiplatform to create a **shared component library** for **Android and iOS** while letting you share this library to our beloved designers, collegues etc with **just a [link](https://gosunet.github.io/composebook/)**. |
| 15 | +Removing the need to install an app to see those components! A bit like **a storybook for native app** 🙌 |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Demo |
| 20 | + |
| 21 | +https://gosunet.github.io/composebook/ |
| 22 | + |
| 23 | + |
| 24 | +## Run Locally |
| 25 | + |
| 26 | +Clone the project |
| 27 | + |
| 28 | +### Run your application on browser |
| 29 | + |
| 30 | +You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task. |
| 31 | + |
| 32 | + |
| 33 | +### Run your application on Android |
| 34 | + |
| 35 | +- Create an Android virtual device. |
| 36 | +- In the list of run configurations, select **composeApp**. |
| 37 | +- Choose your Android virtual device and click **Run**. |
| 38 | + |
| 39 | +### Run your application on iOS |
| 40 | + |
| 41 | +- 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. |
| 42 | +- In the list of run configurations, select **iosApp** and click **Run**. |
| 43 | +- If you don't have an available iOS configuration in the list, add a new iOS simulated device. |
| 44 | +## Authors |
| 45 | + |
| 46 | +- [@Gosunet](https://www.github.com/Gosunet) |
| 47 | + |
| 48 | + |
| 49 | +## Contributing |
| 50 | + |
| 51 | +Contributions are always welcome! |
| 52 | + |
| 53 | +## Appendix |
| 54 | + |
14 | 55 | Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),
|
15 | 56 | [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),
|
16 | 57 | [Kotlin/Wasm](https://kotl.in/wasm/)…
|
17 | 58 |
|
18 |
| -**Note:** Compose/Web is Experimental and may be changed at any time. Use it only for evaluation purposes. |
19 |
| -We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web). |
20 |
| -If you face any issues, please report them on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues). |
21 |
| - |
22 |
| -You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task. |
|
0 commit comments