Skip to content

A Jetpack Compose Multiplatform project template that quickly generates Android, iOS, and Desktop (JVM).

License

Notifications You must be signed in to change notification settings

BetterAndroid/compose-multiplatform-template

Repository files navigation

compose-multiplatform-template

GitHub license Telegram Telegram QQ

LOGO

A Jetpack Compose Multiplatform project template that quickly generates Android, iOS, and Desktop (JVM).

English | 简体中文

LOGO BetterAndroid

This project belongs to the above-mentioned organization, click the link above to follow this organization and discover more good projects.

What's this

This is a Jetpack Compose Multiplatform project template that quickly generates Android, iOS, and Desktop (JVM).

The cross-platform capability of Jetpack Compose provides Android developers with the possibility to deploy applications to multiple platforms.

This template is modified from the official Kotlin Multiplatform Wizard.

This template integrates Flexi UI and BetterAndroid to provide a better native experience for multi-platforms.

If you only use Jetpack Compose to develop Android apps, please refer to another template android-compose-app-template.

Get Started

Click the "Use this template" button on GitHub to use this template.

After successfully creating a new repository, use the git clone command to clone your project locally, do not open the project immediately at this time.

In the root directory of the project, you can find two files, initializer.json and initializer.py, please open the initializer.json file, the contents are as follows.

{
   // Your project name, this will be used as the name of the entire Gradle project, only English is allowed
   "__PROJECT_NAME__": "compose-multiplatform-demo",
   // Your app name
   "__APP_NAME__": "Compose Multiplatform Demo",
   // Your project group name (Package Name for Android, Group for Java, Bundle ID for iOS)
   "__GROUP_NAME__": "com.highcapable.composemultiplatformdemo"
}

After editing the configuration file, run the initializer.py script to initialize the project, after successful initialization, these two files will be automatically deleted.

If there is no Python in your system, please go to official website to download one, and then execute python3 initializer.py on the command line.

If you are using macOS or Linux, you can execute ./initializer.py directly.

After the project is initialized successfully, you can use Android Studio or IntelliJ IDEA to open the project and ensure that you have correctly installed kotlin-multiplatform-mobile plugin.

To compile the iOS project normally, you need to use macOS for development and install Xcode.

Promotion

Hey, please stay! 👋

Here are related projects such as Android development tools, UI design, Gradle plugins, Xposed Modules and practical software.

If the project below can help you, please give me a star!

All projects are free, open source, and follow the corresponding open source license agreement.

Star History

Star History Chart

License

Apache License Version 2.0

Copyright (C) 2019-2024 HighCapable

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 at

    https://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.

Copyright © 2019-2024 HighCapable

About

A Jetpack Compose Multiplatform project template that quickly generates Android, iOS, and Desktop (JVM).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published