https://github.com/cometchat/cometchat-sample-app-flutter
Voice & Video Calling and Text Chat App for Flutter
https://github.com/cometchat/cometchat-sample-app-flutter
app calling chat conference flutter messaging video voice
Last synced: 4 months ago
JSON representation
Voice & Video Calling and Text Chat App for Flutter
- Host: GitHub
- URL: https://github.com/cometchat/cometchat-sample-app-flutter
- Owner: cometchat
- License: other
- Created: 2022-04-04T14:41:17.000Z (about 3 years ago)
- Default Branch: v4
- Last Pushed: 2024-08-09T14:45:59.000Z (9 months ago)
- Last Synced: 2025-01-17T15:09:36.873Z (4 months ago)
- Topics: app, calling, chat, conference, flutter, messaging, video, voice
- Language: Dart
- Homepage: https://www.cometchat.com
- Size: 1.14 MB
- Stars: 38
- Watchers: 15
- Forks: 31
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Sample App by CometChat
This reference application showcases the integration of [**CometChat's Flutter UI Kit**](https://www.cometchat.com/docs/v4/flutter-uikit/overview) within an Flutter framework. It provides developers with examples of implementing real-time messaging and voice and video calling features in their Flutter-based applications.
## Prerequisites
- XCode for iOS and Android Studio for Android
- pod (CocoaPods) for iOS
- Android device or emulator with Android version 5.0 or above.
- An iOS device or emulator with iOS 12.0 or above.
- Sign up for a [CometChat](https://app.cometchat.com/) 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-flutter.git
```
2. Navigate to the project directory:
```sh
cd cometchat-sample-app-flutter
```
3. Install flutter dependencies
```sh
flutter pub get
```
4. Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [lib/app_constants.dart](lib/app_constants.dart) file:
https://github.com/cometchat/cometchat-sample-app-flutter/blob/68a5a3257ad7cfe3ac06a1c9b7de8f94f8ae4227/lib/app_constants.dart#L1-L5
5. 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 [lib/services/api_services.dart](https://github.com/cometchat/cometchat-sample-app-flutter/blob/v4/lib/services/api_services.dart) file: https://github.com/cometchat/cometchat-sample-app-flutter/blob/68a5a3257ad7cfe3ac06a1c9b7de8f94f8ae4227/lib/services/api_services.dart#L13-L15
6. For iOS, install dependencies after navigating to ios :
```sh
cd ios
pod install
```
If you are facing any issue with pod install, you can try running the following command:
```sh
pod update
```
7. Open a Simulator or connect a physical device.
8. Run the app on a device or emulator from the repo root.
```sh
flutter run
```
## Help and Support
For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/flutter-uikit/integration) or create a [support ticket](https://help.cometchat.com/hc/en-us) or seek real-time support via the [CometChat Dashboard](https://app.cometchat.com/).