Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.67 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.67 KB
Raw

Carbon | Compose Multiplatform

Carbon catalog pres

Kotlin Compose Multiplatform

CI | compile & tests

A Compose Multiplatform implementation of the Carbon Design System.

Supported platforms:

  • Android
  • iOS
  • Desktop
  • Web via Wasm

Caution

This library is still under development and unofficial. Contributions are welcomed!

🤳 Catalog App

For testing purposes, this project provides a catalog app for supported targets.

As this is a KMP project, please follow those steps to setup your environment accordingly.

Android 🤖

You can either run the app from the Android App run configuration in Android Studio, or compile an APK by executing the assemble task in a terminal:

./gradlew :catalog:assemble

iOS 

To run the iOS catalog app, open the Xcode project located in <git repo>/iosCatalog and run it (⌘R).

Desktop 🖥️

You can run the desktop version by executing the run Gradle task in a terminal:

./gradlew :catalog:run

Browser 🌐

You can access the web catalog app at https://gabrieldrn.github.io/carbon-compose/catalog/index.html.

Or you can run the web version locally by executing the wasmJsBrowserRun Gradle task in a terminal:

./gradlew :catalog:wasmJsBrowserRun

Documentation

Visit the project's Github Pages https://gabrieldrn.github.io/carbon-compose/ to get more information about the project, some documentation, its API reference and the catalog app.

Contributions

The project is open for contributions, have a look at the contribution guidelines and the issues list!

Support the project 🫶

Maintaining a free and open-source project takes time! If you like it and would like to encourage me, you can:

  • Star and share the project,
  • Offer me a latte ☕ (my daily fuel) with the GitHub sponsoring button on this repository main page.

Thank you very much for your support!