Readme Updated

cometchat · Jan 20, 2025 · 6f4204f · 6f4204f
1 parent f60e736
commit 6f4204f
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,14 @@ experience into an existing or a new app.
    <img src="screenshots/overview_cometchat_screens.png">
 </div>
 
+## 🚀 Explore the Sample Apps!
+
+Dive straight into our Sample Apps to see CometChat UI Kit in action! Whether you're building a messaging app or enhancing your existing project, this sample app showcases the full potential of our React UI components.  
+- [Sample App for Java](sample-app-java#readme)
+- [Sample App for Java with Push Notifications](sample-app-java%2Bpush-notification#readme)
+- [Sample App for Kotlin](sample-app-kotlin#readme)
+- [Sample App for Kotlin with Push Notifications](sample-app-kotlin%2Bpush-notification#readme)
+
 ## Prerequisites
 
 - Android Studio
@@ -30,12 +38,12 @@ To set up CometChat Android UI Kit and utilize CometChat for your chat functiona
 2. After registering, log into your CometChat account and create a new app. Once created, CometChat will generate an Auth Key and App ID for you. Keep
    these credentials secure as you'll need them later.
 
-3. Check the [Key Concepts](https://www.cometchat.com/docs/android-uikit/key-concepts) to understand the basic components of CometChat.
+3. Check the [Key Concepts](https://www.cometchat.com/docs/fundamentals/key-concepts) to understand the basic components of CometChat.
 
-4. Refer to the [Integration Steps](https://www.cometchat.com/docs/android-uikit/integration) in our documentation to integrate the UI Kit into your
+4. Refer to the [Integration Steps](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) in our documentation to integrate the UI Kit into your
    Android app.
 
 ## Help and Support
 
-For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/android-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/).
+For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started)
+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/).
diff --git a/sample-app-java+push-notification/README.md b/sample-app-java+push-notification/README.md
@@ -3,7 +3,7 @@
   <img alt="CometChat" src="https://assets.cometchat.io/website/images/logos/banner.png">
 </p>
 
-# Android Sample App by CometChat
+# Android Sample App with Push Notifications for Java by CometChat
 
 This is a reference application showcasing the integration of [CometChat's Android UI Kit](https://www.cometchat.com/docs/ui-kit/android/5.0/overview) in a native Android application using Kotlin. It demonstrates how to implement real-time messaging and voice/video calling features with ease.
 
@@ -31,30 +31,26 @@ This is a reference application showcasing the integration of [CometChat's Andro
    git checkout v5
    ```
 
-3. Open the project in Android Studio by navigating to the cloned directory and open the `sample-app-java+push-notification` folder.
+3. Sync Gradle to ensure all dependencies are downloaded.
 
-4. Sync Gradle to ensure all dependencies are downloaded.
-
-5. `[Optional]` Configure CometChat credentials:
-   - Open the `AppCredentials.java` file located at `sample-app-java+push-notification/src/main/java/com/cometchat/sampleapp/java/fcm/AppCredentials.java` and enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_:
-     ```java
-     public class AppCredentials {
-         public static final String APP_ID = "YOUR_APP_ID";
-         public static final String REGION = "YOUR_REGION";
-         public static final String AUTH_KEY = "YOUR_AUTH_KEY";
-     }
-     ```
-6. Set up Firebase Cloud Messaging (FCM) by following the below steps
+4. `[Optional]` Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [AppCredentials.java](src/main/java/com/cometchat/sampleapp/java/fcm/AppCredentials.java) file:
+   file:https://github.com/cometchat/cometchat-uikit-android/blob/b7b7c0d76eb70960728e6622ed7f70ab4e45b4af/sample-app-java%2Bpush-notification/src/main/java/com/cometchat/sampleapp/java/fcm/AppCredentials.java#L3-L11
+
+5. Set up Firebase Cloud Messaging (FCM) by following the below steps
     - Go to the [Firebase Console](https://console.firebase.google.com/) and create a project.
     - Add your Android app to the Firebase project and download the `google-services.json` file.
     - Place the `google-services.json` file in the `sample-app-java+push-notification/` directory of your project.
 
-7. Set up CometChat Push Notification:
+6. Set up CometChat Push Notification:
    - Go to the [Notification Documentation](https://www.cometchat.com/docs/notifications/push-integration) and follow integration steps.
+   - Note the provider id entered while configuring the Push Notifications in CometChat Dashboard.
+
+7. Update the provider id from the step 7 in [AppConstants.java](src/main/java/com/cometchat/sampleapp/java/fcm/utils/AppConstants.java) file:https://github.com/cometchat/cometchat-uikit-android/blob/aa63fc07e27822175f9cba03c789a0d08b367d01/sample-app-java+push-notification/src/main/java/com/cometchat/sampleapp/java/fcm/utils/AppConstants.java#L34-L36
+
+8. In the Android Studio toolbar, select the `sample-app-java+push-notification` module from the module dropdown and run the project using an emulator or a physical device 
 
-8. Run the project using an emulator or a physical device to build and run the sample app.
 
 
 ## Help and Support
 
-For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
+For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
diff --git a/sample-app-java/README.md b/sample-app-java/README.md
@@ -3,7 +3,7 @@
   <img alt="CometChat" src="https://assets.cometchat.io/website/images/logos/banner.png">
 </p>
 
-# Android Sample App by CometChat
+# Android Sample App for Java by CometChat
 
 This is a reference application showcasing the integration of [CometChat's Android UI Kit](https://www.cometchat.com/docs/ui-kit/android/5.0/overview) in a native Android application. It demonstrates how to implement real-time messaging and voice/video calling features with ease.
 
@@ -31,22 +31,16 @@ This is a reference application showcasing the integration of [CometChat's Andro
    git checkout v5
    ```
 
-3. Open the project in Android Studio by navigating to the cloned directory and open the `sample-app-java` folder.
+3. Open the project in Android Studio.
 
-4.  Sync Gradle to ensure all dependencies are downloaded.
+4. Sync Gradle to ensure all dependencies are downloaded.
 
-5. `[Optional]` Configure CometChat credentials:
-   - Open the `AppCredentials.java` file located at `sample-app-java/src/main/java/com/cometchat/sampleapp/java/AppCredentials.java` and enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_:
-     ```java
-     public class AppCredentials {
-         public static final String APP_ID = "YOUR_APP_ID";
-         public static final String REGION = "YOUR_REGION";
-         public static final String AUTH_KEY = "YOUR_AUTH_KEY";
-     }
-     ```
+5. `[Optional]` Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [AppCredentials.java](src/main/java/com/cometchat/sampleapp/java/AppCredentials.java) file:
+   file:https://github.com/cometchat/cometchat-uikit-android/blob/b7b7c0d76eb70960728e6622ed7f70ab4e45b4af/sample-app-java/src/main/java/com/cometchat/sampleapp/java/AppCredentials.java#L3-L7
+
+6. In the Android Studio toolbar, select the `sample-app-java` module from the module dropdown and run the project using an emulator or a physical device 
 
-6. Run the project using an emulator or a physical device to build and run the sample app.
 
 ## Help and Support
 
-For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
+For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
diff --git a/sample-app-kotlin+push-notification/README.md b/sample-app-kotlin+push-notification/README.md
@@ -3,7 +3,7 @@
   <img alt="CometChat" src="https://assets.cometchat.io/website/images/logos/banner.png">
 </p>
 
-# Android Sample App by CometChat
+# Android Sample App with Push Notifications for Kotlin by CometChat
 
 This is a reference application showcasing the integration of [CometChat's Android UI Kit](https://www.cometchat.com/docs/ui-kit/android/5.0/overview) in a native Android application using Kotlin. It demonstrates how to implement real-time messaging and voice/video calling features with ease.
 
@@ -31,29 +31,24 @@ This is a reference application showcasing the integration of [CometChat's Andro
    git checkout v5
    ```
 
-3. Open the project in Android Studio by navigating to the cloned directory and open the `sample-app-kotlin+push-notification` folder.
+3. Sync Gradle to ensure all dependencies are downloaded.
 
-4. Sync Gradle to ensure all dependencies are downloaded.
+4. `[Optional]` Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [AppCredentials.java](src/main/java/com/cometchat/sampleapp/kotlin/fcm/AppCredentials.kt) file:
+   file:https://github.com/cometchat/cometchat-uikit-android/blob/b7b7c0d76eb70960728e6622ed7f70ab4e45b4af/sample-app-kotlin+push-notification/src/main/java/com/cometchat/sampleapp/kotlin/fcm/AppCredentials.kt#L3-L11
 
-5. `[Optional]` Configure CometChat credentials:
-    - Open the `AppCredentials.kt` file located at `sample-app-kotlin+push-notification/src/main/java/com/cometchat/sampleapp/kotlin/fcm/AppCredentials.kt` and enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_:
-      ```kotlin
-      object AppConstants {
-          const val APP_ID = "YOUR_APP_ID"
-          const val REGION = "YOUR_REGION"
-          const val AUTH_KEY = "YOUR_AUTH_KEY"
-      }
-      ```
-6. Set up Firebase Cloud Messaging (FCM):
+5. Set up Firebase Cloud Messaging (FCM):
     - Go to the [Firebase Console](https://console.firebase.google.com/) and create a project.
     - Add your Android app to the Firebase project and download the `google-services.json` file.
     - Place the `google-services.json` file in the `sample-app-kotlin+push-notification/` directory of your project.
 
-7. Set up CometChat Push Notification:
+6. Set up CometChat Push Notification:
    - Go to the [Notification Documentation](https://www.cometchat.com/docs/notifications/push-integration) and follow integration steps.
+   - Note the provider id entered while configuring the Push Notifications in CometChat Dashboard.
 
-8. Run the project Use an emulator or a physical device to build and run the sample app.
+7. Update the provider id from the step 7 in [AppConstants.kt](src/main/java/com/cometchat/sampleapp/kotlin/fcm/utils/AppConstants.kt) file:https://github.com/cometchat/cometchat-uikit-android/blob/aa63fc07e27822175f9cba03c789a0d08b367d01/sample-app-kotlin+push-notification/src/main/java/com/cometchat/sampleapp/kotlin/fcm/utils/AppConstants.kt#L24-L26
+
+8. In the Android Studio toolbar, select the `sample-app-kotlin+push-notification` module from the module dropdown and run the project using an emulator or a physical device 
 
 ## Help and Support
 
-For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
+For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
diff --git a/sample-app-kotlin/README.md b/sample-app-kotlin/README.md
@@ -3,7 +3,7 @@
   <img alt="CometChat" src="https://assets.cometchat.io/website/images/logos/banner.png">
 </p>
 
-# Android Sample App by CometChat
+# Android Sample App for Kotlin by CometChat
 
 This is a reference application showcasing the integration of [CometChat's Android UI Kit](https://www.cometchat.com/docs/ui-kit/android/5.0/overview) in a native Android application using Kotlin. It demonstrates how to implement real-time messaging and voice/video calling features with ease.
 
@@ -35,18 +35,11 @@ This is a reference application showcasing the integration of [CometChat's Andro
 
 4. Sync Gradle to ensure all dependencies are downloaded.
 
-5. `[Optional]` Configure CometChat credentials:
-    - Open the `AppCredentials.kt` file located at `sample-app-kotlin+push-notification/src/main/java/com/cometchat/sampleapp/kotlin/fcm/AppCredentials.kt` and enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_:
-      ```kotlin
-      object AppConstants {
-          const val APP_ID = "YOUR_APP_ID"
-          const val REGION = "YOUR_REGION"
-          const val AUTH_KEY = "YOUR_AUTH_KEY"
-      }
-      ```
+5. `[Optional]` Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [AppCredentials.java](src/main/java/com/cometchat/sampleapp/kotlin/AppCredentials.kt) file:
+   file:https://github.com/cometchat/cometchat-uikit-android/blob/b7b7c0d76eb70960728e6622ed7f70ab4e45b4af/sample-app-kotlin/src/main/java/com/cometchat/sampleapp/kotlin/AppCredentials.kt#L3-L11
 
-6. Run the project using an emulator or a physical device to build and run the sample app.
+6. In the Android Studio toolbar, select the `sample-app-kotlin` module from the module dropdown and run the project using an emulator or a physical device 
 
 ## Help and Support
 
-For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).
+For issues running the project or integrating with our UI Kits, consult our [documentation](https://www.cometchat.com/docs/ui-kit/android/5.0/getting-started) or create a [support ticket](https://help.cometchat.com/hc/en-us). You can also access real-time support via the [CometChat Dashboard](http://app.cometchat.com/).