markdown-body entry-content container-lg" itemprop="text">

Flutter Sample App by CometChat

This is a reference application showcasing the integration of CometChat's Flutter UI Kit in a Flutter project. It demonstrates how to implement real-time messaging and voice/video calling features with ease.

Prerequisites

iOS

XCode
Pod (CocoaPods) for iOS
An iOS device or emulator with iOS 12.0 or above.
Ensure that you have configured the provisioning profile in Xcode to run the app on a physical device.

Android

Android Studio
Android device or emulator with Android version 5.0 or above.

Installation

Clone the repository:

git clone https://github.com/cometchat/cometchat-uikit-flutter.git

Checkout v5 branch:
```
git checkout v5
```
Open the project in Android Studio by navigating to the cloned directory.
Run flutter pub get to fetch all dependencies.
[Optional] Configure CometChat credentials:
- Open the app_credentials.dart file located at sample_app/lib/app_credentials.dart and enter your CometChat App ID, Region, and Auth Key:
```
AppCredentials {
   static String _appId = "YOUR_APP_ID";
   static String _authKey = "YOUR_AUTH_KEY";
   static String _region = "REGION";
}
```
In the Run/Debug Configurations dropdown (on the top toolbar), select the preconfigured sample_app run configuration. Connect a physical device or select an emulator from the Device Selector dropdown. Click the Run ▶ button to launch the app.

Note: If the provisioning profile is not set up correctly in Xcode, you may encounter errors when running the app on a physical iOS device. Ensure that you have configured the provisioning profile before proceeding.

Help and Support

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