ptm0304 / android-kotlin-chat-app Goto Github PK

CometChat Android Demo app (built using CometChat Pro) is a fully functional messaging app capable of one-on-one (private) and group messaging. The app enables users to send text and multimedia messages like audio, video, images, documents.

1. Screenshots

2. Installation

3. Run the Sample App

4. Customizing the UI

5. Integrating this sample into your own app

6. Contribute

7. Issue Template

Simply Clone the project from android-kotlin-chat-app repository and open in Android Studio. Build the Demo App and it will be ready to Run

To run our open source app with CometChat Pro v2, follow these steps:

1. Checkout to branch v2

• modify APP_ID and API_KEY with your own ApiKey , AppId and REGION

  `val APP_ID: String = "XXXXXXXXX"`
  
  `val API_KEY: String  = "XXXXXXXXX"`
  
  `val REGION: String = "XXXXXX"`
  

2. Build and run the Sample App.

To run our open source app with CometChat Pro v1, follow these steps:

1. Checkout to branch v1.8

• modify APP_ID and API_KEY with your own ApiKey and AppId

  `val APP_ID: String = "XXXXXXXXX"`
  
  `val API_KEY: String  = "XXXXXXXXX"`
  

2. Build and run the Sample App.

Branch v1.8 contains UI with SDK v1.8+ .

Branch v2.0 contains UI with SDK v2.0+ . Apps created in v2 requires Region. Branch v2 and master contains CometChat Pro SDK with latest feature and updates

To Run to sample App you have to do the following changes by Adding ApiKey , AppId and REGION

• Open the Project in Android Mode in Android Studio

• Go to Under java --> com\inscripts\cometchatpulse--> StringContract

• Under class StringContract.kt go to class named AppDetails

• modify APP_ID and API_KEY with your own ApiKey , AppId and REGION

  val APP_ID: String = "XXXXXXXXX"

  val API_KEY: String = "XXXXXXXXX"

  val REGION: String = "us"

  us = USA (if your app region is USA).
  
  
  eu = EUROPE (if your app region is EUROPE).
  

Find out more with the new Dashboard.CometChat-Pro Dashboard

• To Run the app you also need to include google-services.json from your firebase console ,To connect the app to
  firebase follow the instruction below :

  Add Firebase to your Android project

• To enable push notification in your app you also need to enable push notification extension in your app from CometChat DashBoard.To enable push notification extension follow the below steps:

  • Go to your app in CometChat Dashboard
  • Go to Extension section
  • Add Push Notification Extension
  • Add FCM Server Key in Push Notification Extension

You can Obtain your APP_ID and API_KEY from CometChat-Pro Dashboard

For more information read CometChat-Pro Android SDK Documentation

We have provided three themes with our sample app namely PersianBlue, MountainMeadow, AzureRadiance. To apply the themes:

• Go to Application class CometChatPro

• Create constructor of class Appearance and pass any of these three values

  1.PERSIAN_BLUE

  2.MOUNTAIN_MEADOW

  3.AZURE_RADIANCE

example Appearance(Appearance.AppTheme.PERSIAN_BLUE)

To make your custom appearance go to Appearance class under package named Utils i.e

Go to Under java --> com\inscripts\cometchatpulse--> Utils--> Appearance

Copy sample app in your project

remove login and add your own authentication method

launch MainActivity and start using the app

Feel free to make Pull Request.

To report an issue or bug please follow the template to create a github issue

ISSUE TEMPLATE