|
1 | | -<!-- PROJECT LOGO --> |
2 | | -<p align="left"> |
3 | | - <a href="https://cometchat.com"> |
4 | | - <img src="./Screenshots/logo.png" alt="CometChat logo" width="180" height="180"> |
5 | | - </a> |
| 1 | +# Android Sample App by CometChat |
6 | 2 |
|
7 | | -<h2 align="left">Android Java Sample App</h3> |
| 3 | +This is a reference application showcasing the integration of [**CometChat's Android UI Kit**](https://www.cometchat.com/docs/v4/android-uikit/overview) within an Android framework. It provides developers with examples of implementing real-time messaging and voice and video calling features in their own Android-based applications. |
8 | 4 |
|
9 | | - <p align="left"> |
10 | | - CometChat Kitchen Sink Sample App (built using <b>CometChat UI Kits</b>) is a fully functional real-time messaging app capable of private (one-on-one), group messaging, voice & video calling. |
11 | | - <br /> |
12 | | - <a href="https://www.cometchat.com/docs/v4/android-uikit/overview"><strong>Explore the docs »</strong></a> |
13 | | - <br /> |
14 | | - <br /> |
15 | | - <a href="https://github.com/cometchat-pro/cometchat-chat-sample-app-android-java/issues">Report Bug</a> |
16 | | - </p> |
| 5 | +## Prerequisites |
17 | 6 |
|
18 | | -<div align="left"> |
19 | | - <a href="https://github.com/cometchat-pro/android-java-chat-app/releases/" alt="Releases"> |
20 | | - <img src="https://img.shields.io/github/v/release/cometchat-pro/android-java-chat-app" /> |
21 | | - </a> |
22 | | - <a href="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app"> |
23 | | - <img src="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app" /> |
24 | | - </a> |
25 | | - <a href="https://github.com/cometchat-pro/android-java-chat-app/stargazers"> |
26 | | - <img src="https://img.shields.io/github/stars/cometchat-pro/android-java-chat-app?style=social" /> |
27 | | - </a> |
28 | | - <a href="https://twitter.com/CometChat"> |
29 | | - <img src="https://img.shields.io/twitter/follow/CometChat?label=CometChat&style=social" /> |
30 | | - </a> |
31 | | -</div> |
| 7 | +- Android Studio |
| 8 | +- Android Device or emulator with Android version 6.0 or above. |
| 9 | +- Java or above. |
| 10 | +- Sign up for a [CometChat](https://app.cometchat.com/) account to get your app credentials: _`App ID`_, _`Region`_, and _`Auth Key`_ |
32 | 11 |
|
33 | | -<!-- TABLE OF CONTENTS --> |
34 | 12 |
|
35 | | -## Table of Contents |
| 13 | +## Installation |
| 14 | +1. Clone the repository: |
| 15 | + ``` |
| 16 | + git clone https://github.com/cometchat/cometchat-sample-app-android-java.git |
| 17 | + ``` |
| 18 | +2. In Android Studio, open the project cometchat-sample-app-android-java |
36 | 19 |
|
37 | | -- [About the Project](#about-the-project) |
38 | | - - [Prerequisites](#Prerequisites) |
39 | | -- [Getting Started](#getting-started) |
40 | | - - [Dependencies](#dependencies) |
41 | | - - [Installing](#installing) |
42 | | - - [Usage](#usage) |
43 | | - - [Run locally](#run-project-locally) |
44 | | - - [Help](#help) |
45 | | -- [Contributing](#contributing) |
46 | | -- [Support](#support) |
47 | | -- [License](#license) |
48 | | -- [About Authors](#about-authors) |
49 | | - |
50 | | -<!-- ABOUT THE PROJECT --> |
51 | | - |
52 | | -## About The Project |
53 | | - |
54 | | -CometChat Kitchen Sink Sample App (built using **CometChat UI Kit**) is a fully functional real-time messaging app capable of private (one-on-one), group messaging, voice & video calling. |
55 | | - |
56 | | -### Prerequisites |
57 | | - |
58 | | -- ✅ You have Android Studio installed in your machine. |
59 | | -- ✅ You have an Android Device or emulator with Android Version 6.0 or above. |
60 | | -- ✅ You have kotlin version 1.8 or Java 8 and above |
61 | | - |
62 | | -<!-- GETTING STARTED --> |
63 | | - |
64 | | -## Getting Started |
65 | | - |
66 | | -Simply clone or fork this repo and run it using the instructions below to see all features in action. Or use it as a starter template/boilerplate and make edits to suit your needs. |
67 | | - |
68 | | -## Dependencies |
69 | | - |
70 | | -- CometChat - [Sign up for CometChat](https://app.cometchat.com) and create an app to obtain your keys and other credentials |
71 | | - |
72 | | -## Installing |
73 | | - |
74 | | -1. Clone the repo |
75 | | - |
76 | | - ```sh |
77 | | - git clone https://github.com/cometchat-pro/cometchat-chat-sample-app-android-java.git |
78 | | - ``` |
79 | | - |
80 | | -2. Change to the working directory |
81 | | - |
82 | | - ```sh |
83 | | - cd cometchat-chat-sample-app-android-java |
84 | | - ``` |
85 | | - |
86 | | -3. Change the Branch |
87 | | - |
88 | | - ```sh |
89 | | - git checkout v4 |
90 | | - ``` |
91 | | - |
92 | | -4. Replace `APP_ID`, `REGION`, and `AUTH_KEY` with your CometChat `App ID`, `Region`, and `Auth Key` in `AppConstants.java` file. |
93 | | -```java |
| 20 | +3. Enter your CometChat _`App ID`_, _`Region`_, and _`Auth Key`_ in the [app/src/main/java/com/cometchat/javasampleapp/AppConstants.java](https://github.com/cometchat/cometchat-sample-app-android-java/blob/v4/app/src/main/java/com/cometchat/javasampleapp/AppConstants.java) file: |
| 21 | + ```java |
94 | 22 | public static final String APP_ID = "XXXXXXXXXXXXXXXXX"; |
95 | | - |
96 | 23 | public static final String AUTH_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; |
97 | | - |
98 | 24 | public static final String REGION = "XX"; |
99 | | -``` |
100 | | - |
101 | | -<!-- USAGE EXAMPLES --> |
102 | | - |
103 | | -## Usage |
104 | | - |
105 | | -This app contains all features offered by CometChat through its UI Kit. [Read more about the Android UI Kit here.](https://www.cometchat.com/docs/v4/android-uikit/overview) |
106 | | - |
107 | | -### Run project locally |
108 | | - |
109 | | -- Open the project in Android Studio. |
110 | | - |
111 | | - - Build and run the Sample App. |
112 | | - - Select demo users or enter the **UID** at the time of login once the app is launched. |
113 | | - |
114 | | -To learn about Android UI Kit Integration, please [click here](https://www.cometchat.com/docs/v4/android-uikit/integration). |
115 | | - |
116 | | -## Help |
117 | | - |
118 | | -To learn more about our UI kits, visit our [documentation](https://www.cometchat.com/docs/v4-uikits). |
119 | | - |
120 | | -If you are still facing issues while running this project or integrating with our UI Kits, please connect with our real-time support via the [CometChat Dashboard](https://app.cometchat.com/). |
121 | | - |
122 | | -<!-- CONTRIBUTING --> |
123 | | - |
124 | | -## Contributing |
125 | | - |
126 | | -Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. Sincere thanks to all our [contributors](https://github.com/cometchat-pro/android-java-chat-app/graphs/contributors)! |
127 | | - |
128 | | -You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:. |
129 | | - |
130 | | -## Support |
131 | | - |
132 | | -Please connect with our real-time support via the [CometChat Dashboard](https://app.cometchat.com/). |
133 | | - |
134 | | -<!-- LICENSE.md --> |
135 | | - |
136 | | -## License |
137 | | - |
138 | | -This project is licensed under the MIT License - see the [LICENSE](./LICENSE.md) file for details. |
139 | | - |
140 | | -## About Authors |
141 | | - |
142 | | -`cometchat-chat-sample-app-android-java` is created & maintained by CometChat. |
143 | | - |
144 | | -The names and logos for CometChat are trademarks of CometChat, Inc. |
| 25 | + ``` |
| 26 | +4. Run the app on a device or emulator. |
| 27 | + |
145 | 28 |
|
146 | | -We love open-source software! See [our other projects](https://github.com/cometchat-pro) or [sign up with us](https://app.cometchat.com) to start using our product. |
| 29 | +## Help and Support |
| 30 | +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](http://app.cometchat.com/). |
0 commit comments