Skip to content

Commit 0965608

Browse files
vivekCometChatvivekCometChat
committed
v4.0.0-beta.1
1 parent ec70124 commit 0965608

File tree

174 files changed

+7555
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

174 files changed

+7555
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.
18+
19+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
In the interest of fostering an open and welcoming environment, we as
24+
contributors and maintainers pledge to making participation in our project and
25+
our community a harassment-free experience for everyone, regardless of age, body
26+
size, disability, ethnicity, gender identity and expression, level of experience,
27+
nationality, personal appearance, race, religion, or sexual identity and
28+
orientation.
29+
30+
### Our Standards
31+
32+
Examples of behavior that contributes to creating a positive environment
33+
include:
34+
35+
* Using welcoming and inclusive language
36+
* Being respectful of differing viewpoints and experiences
37+
* Gracefully accepting constructive criticism
38+
* Focusing on what is best for the community
39+
* Showing empathy towards other community members
40+
41+
Examples of unacceptable behavior by participants include:
42+
43+
* The use of sexualized language or imagery and unwelcome sexual attention or
44+
advances
45+
* Trolling, insulting/derogatory comments, and personal or political attacks
46+
* Public or private harassment
47+
* Publishing others' private information, such as a physical or electronic
48+
address, without explicit permission
49+
* Other conduct which could reasonably be considered inappropriate in a
50+
professional setting
51+
52+
### Our Responsibilities
53+
54+
Project maintainers are responsible for clarifying the standards of acceptable
55+
behavior and are expected to take appropriate and fair corrective action in
56+
response to any instances of unacceptable behavior.
57+
58+
Project maintainers have the right and responsibility to remove, edit, or
59+
reject comments, commits, code, wiki edits, issues, and other contributions
60+
that are not aligned to this Code of Conduct, or to ban temporarily or
61+
permanently any contributor for other behaviors that they deem inappropriate,
62+
threatening, offensive, or harmful.
63+
64+
### Scope
65+
66+
This Code of Conduct applies both within project spaces and in public spaces
67+
when an individual is representing the project or its community. Examples of
68+
representing a project or community include using an official project e-mail
69+
address, posting via an official social media account, or acting as an appointed
70+
representative at an online or offline event. Representation of a project may be
71+
further defined and clarified by project maintainers.
72+
73+
### Enforcement
74+
75+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
76+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
77+
complaints will be reviewed and investigated and will result in a response that
78+
is deemed necessary and appropriate to the circumstances. The project team is
79+
obligated to maintain confidentiality with regard to the reporter of an incident.
80+
Further details of specific enforcement policies may be posted separately.
81+
82+
Project maintainers who do not follow or enforce the Code of Conduct in good
83+
faith may face temporary or permanent repercussions as determined by other
84+
members of the project's leadership.
85+
86+
### Attribution
87+
88+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
89+
available at [http://contributor-covenant.org/version/1/4][version]
90+
91+
[homepage]: http://contributor-covenant.org
92+
[version]: http://contributor-covenant.org/version/1/4/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 CometChat Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Readme.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
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>
6+
7+
<h2 align="left">Android Java Sample App</h3>
8+
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/java-uikit-beta/overview"><strong>Explore the docs »</strong></a>
13+
<br />
14+
<br />
15+
<a href="https://github.com/cometchat-pro/android-java-chat-app/issues">Report Bug</a>
16+
</p>
17+
</p>
18+
19+
<div align="left">
20+
<a href="https://github.com/cometchat-pro/android-java-chat-app/releases/" alt="Releases">
21+
<img src="https://img.shields.io/github/v/release/cometchat-pro/android-java-chat-app" />
22+
</a>
23+
<a href="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app">
24+
<img src="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app" />
25+
</a>
26+
<a href="https://github.com/cometchat-pro/android-java-chat-app/stargazers">
27+
<img src="https://img.shields.io/github/stars/cometchat-pro/android-java-chat-app?style=social" />
28+
</a>
29+
<a href="https://twitter.com/CometChat">
30+
<img src="https://img.shields.io/twitter/follow/CometChat?label=CometChat&style=social" />
31+
</a>
32+
</div>
33+
34+
<!-- TABLE OF CONTENTS -->
35+
36+
## Table of Contents
37+
38+
- [About the Project](#about-the-project)
39+
- [Built With](#built-with)
40+
- [Getting Started](#getting-started)
41+
- [Dependencies](#dependencies)
42+
- [Installing](#installing)
43+
- [Usage](#usage)
44+
- [Run locally](#run-project-locally)
45+
- [Help](#help)
46+
- [Contributing](#contributing)
47+
- [Support](#support)
48+
- [License](#license)
49+
- [About Authors](#about-authors)
50+
51+
<!-- ABOUT THE PROJECT -->
52+
53+
## About The Project
54+
55+
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.
56+
57+
### Built With
58+
59+
- [Android](https://developer.android.com/)
60+
- [CometChat](https://cometchat.com)
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/android-java-chat-app.git
78+
```
79+
80+
2. Change to the working directory
81+
82+
```sh
83+
cd android-java-chat-app
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+
94+
![Replacing constants in AppConstants.java](./Screenshots/credentials.png "Replacing constants in AppConstants.java")
95+
96+
<!-- USAGE EXAMPLES -->
97+
98+
## Usage
99+
100+
This app contains all features offered by CometChat through its UI Kit. [Read more about the Android chat UI Kit here.](https://www.cometchat.com/docs/java-uikit-beta/overview)
101+
102+
### Run project locally
103+
104+
- Open the project in Android Studio.
105+
106+
- Modify `APP_ID` and `AUTH_KEY` and `REGION` with your own .
107+
- Build and run the Sample App.
108+
- Select demo users or enter the **UID** at the time of login once the app is launched.
109+
110+
To learn about Android UI Kit Integration, please [click here](https://www.cometchat.com/docs/java-uikit-beta/integration).
111+
112+
## Help
113+
114+
To learn more about our UI kits, visit our [documentation](https://www.cometchat.com/docs/java-uikit-beta/overview).
115+
116+
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/).
117+
118+
<!-- CONTRIBUTING -->
119+
120+
## Contributing
121+
122+
Contributions are what make the open source community such an amazing place to be 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)!
123+
124+
You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.
125+
126+
## Support
127+
128+
Please connect with our real time support via the [CometChat Dashboard](https://app.cometchat.com/).
129+
130+
<!-- LICENSE -->
131+
132+
## License
133+
134+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
135+
136+
## About Authors
137+
138+
`android-java-chat-app` is created & maintained by CometChat.
139+
140+
The names and logos for CometChat are trademarks of CometChat, Inc.
141+
142+
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.

‎SECURITY.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
This document outlines the Responsible Disclosure Program for CometChat Pro
4+
5+
## Responsible Disclosure Policy
6+
7+
At CometChat we take security seriously and consider it a top priority. Since a
8+
public disclosure of a security vulnerability could put the entire
9+
community at risk, we require that potential vulnerabilities are kept
10+
confidential until they are confirmed and fixed. We appreciate your efforts in
11+
keeping CometChat Pro and its users safe by responsibly disclosing any security
12+
vulnerability. Rest assured we will make every effort to acknowledge your
13+
contributions.
14+
15+
## Reporting a vulnerability
16+
17+
To report any security related issues, please communicate with the CometChat Pro security team by sending an email to [email protected]

‎Screenshots/credentials.png‎

27.2 KB
Loading

‎Screenshots/logo.png‎

12.3 KB
Loading

‎Screenshots/uikit_screens.png‎

69.2 KB
Loading

‎app/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

‎app/build.gradle‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
plugins {
2+
id 'com.android.application'
3+
}
4+
5+
android {
6+
compileSdk 33
7+
8+
defaultConfig {
9+
applicationId "com.cometchat.javasampleapp"
10+
minSdk 21
11+
targetSdk 33
12+
versionCode 1
13+
versionName "4.0.0"
14+
15+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
16+
manifestPlaceholders = [file_provider: "com.cometchat.javasampleapp"]
17+
}
18+
19+
buildTypes {
20+
release {
21+
minifyEnabled false
22+
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
23+
}
24+
}
25+
compileOptions {
26+
sourceCompatibility JavaVersion.VERSION_1_8
27+
targetCompatibility JavaVersion.VERSION_1_8
28+
}
29+
namespace 'com.cometchat.javasampleapp'
30+
}
31+
32+
dependencies {
33+
implementation 'com.cometchat:chat-uikit-android:4.0.0-beta.1'
34+
implementation 'androidx.appcompat:appcompat:1.6.1'
35+
implementation 'com.google.android.material:material:1.8.0'
36+
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
37+
testImplementation 'junit:junit:4.13.2'
38+
androidTestImplementation 'androidx.test.ext:junit:1.1.5'
39+
androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
40+
implementation 'com.cometchat:pro-android-calls-sdk:3.0.0'
41+
}

‎app/proguard-rules.pro‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add project specific ProGuard rules here.
2+
# You can control the set of applied configuration files using the
3+
# proguardFiles setting in build.gradle.
4+
#
5+
# For more details, see
6+
# http://developer.android.com/guide/developing/tools/proguard.html
7+
8+
# If your project uses WebView with JS, uncomment the following
9+
# and specify the fully qualified class name to the JavaScript interface
10+
# class:
11+
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12+
# public *;
13+
#}
14+
15+
# Uncomment this to preserve the line number information for
16+
# debugging stack traces.
17+
#-keepattributes SourceFile,LineNumberTable
18+
19+
# If you keep the line number information, uncomment this to
20+
# hide the original source file name.
21+
#-renamesourcefileattribute SourceFile

0 commit comments

Comments
 (0)