README.md

Android Sample App by CometChat

This is a reference application showcasing the integration of CometChat's Android UI Kit within an Android Kotlin framework. It provides developers with examples of implementing real-time messaging and voice and video calling features in their own Android-based applications.

Prerequisites

• Android Studio
• Android Device or emulator with Android version 6.0 or above.
• Kotlin 1.7.0 or above.
• Sign up for a CometChat account to get your app credentials: App ID, Region, and Auth Key

Installation

1. Clone the repository:

   git clone https://github.com/cometchat/cometchat-sample-app-android-kotlin.git
   

2. In Android Studio, open the project cometchat-sample-app-android-kotlin

3. Enter your CometChat App ID, Region, and Auth Key in the AppConstants.kt file:

   cometchat-sample-app-android-kotlin/app/src/main/java/com/cometchat/kotlinsampleapp/AppConstants.kt

   Lines 3 to 11 in 0430695

   	object AppConstants {
   	const val APP_ID = "XXXXXXXXXXXXXXXXXX"
   	const val AUTH_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
   	const val REGION = "XX"
   	}

4. If your app is created before August 12th, 2024 then change the sample data URL to https://assets.cometchat.io/sampleapp/v1/sampledata.json in the app/src/main/java/com/cometchat/kotlinsampleapp/constants/StringConstants.kt file:

   cometchat-sample-app-android-kotlin/app/src/main/java/com/cometchat/kotlinsampleapp/constants/StringConstants.kt

   Lines 11 to 13 in 0430695

   	const val KEY_USER: String = "users"
   	const val SAMPLE_APP_USERS_URL: String = "https://assets.cometchat.io/sampleapp/sampledata.json"
   	const val UID: String = "uid"

5. Run the app on a device or emulator.

Help and Support

For issues running the project or integrating with our UI Kits, consult our documentation or create a support ticket or seek real-time support via the CometChat Dashboard.