Skip to content

Customize your app

Give your app a name

To ensure your app has a unique identity in the app stores and on users' devices, you’ll want to give it a name and set a custom package/bundle ID.

This is done by running the renameProject Gradle task, which will automatically handle the necessary changes across your project files.

Important

Make sure to commit your changes before running the rename task. This task will modify multiple files, and it's best to have a backup in case you need to revert.

The task has the following parameters:

  • projectName (required): The new name for your project (e.g. MyApp).
  • packageName (required): The new base package (e.g. com.example.myapp).
  • dryRun (optional): If present, performs a dry run to preview changes without applying them.

Example Usage

./gradlew renameProject -PprojectName=MyApp -PpackageName=com.example.myapp -PdryRun

Remove -PdryRun when you're ready to apply the changes and run the task again, you should see the message Task completed successfully! in the terminal.

Go back to Android Studio and click on "Sync Project with Gradle Files" (the elephant icon) to ensure all changes are fully applied.

Theme

Check out Czan - Theme cuztomization documentation to learn how to customize your theme, including colors, typography, shapes, dark mode, and more.

App icon

Updating the app icon to reflect your brand identity is one of the first things you'll want to do.

Android

The easiest way to change the app icon on Android is by using Image Asset Studio in Android Studio.

Steps:

  1. Open Android Studio.
  2. In the Project view, right-click the androidApp folder.
  3. Select New > Image Asset.
  4. In the Asset Type dropdown, choose either:
    • Image (for a PNG file), or
    • Vector (for an SVG file).
  5. Upload your app icon and configure the foreground and background layers.
  6. Optionally customize padding, scaling, and shape.

  7. Click Next, then Finish. This will automatically generate icons in all required mipmap- folders.

  8. Your app icon is referenced in AndroidManifest.xml:

    AndroidManifest.xml
    <application
    ...   
    android:icon="@mipmap/ic_launcher"
    ...
>

Android Studio Image Asset

iOS

iOS uses an asset catalog (Assets.xcassets) to manage app icons.

Steps:

  1. Prepare your icon assets in all required sizes. You can generate them using a tool like:

  2. Open the iOS project in Xcode (iosApp/iosApp.xcodeproj).

  3. In the Project Navigator, expand iosApp > Assets.xcassets > AppIcon.

  4. Drag and drop the generated icon images into the correct slots in the AppIcon set.

  5. Your app icon is referenced in your target’s Build Settings > Asset Catalog Compiler - Options > Primary App Icon Set Name.

Xcode App Icon

Welcome screen

The WelcomeScreen is the first branded impression users will see. It includes a logo, a title, and a 2-line headline — all of which can be customized.

To change the logo shown on the welcome screen:

  • Replace the XML file named welcome_logo.xml
  • File location: shared/presentation/src/commonMain/composeResources/drawable
  • Keep the same filename (welcome_logo.xml) so that no code changes are needed.

Title

To change the main app title displayed:

  • Open the strings.xml file
  • Modify the value for the key: 
    <string name="app_name">Your App Name</string>

Headline (2-line)

To change the headline text below the title:

  • Still in strings.xml, update the following keys: 
    <string name="welcome_headline_one">Your first headline line</string>
<string name="welcome_headline_two">Your second headline line</string>

These updates will be reflected automatically the next time you run the app.