Skip to content

Latest commit

 

History

History
150 lines (101 loc) · 5.03 KB

README.md

File metadata and controls

150 lines (101 loc) · 5.03 KB
Raw
CometChat

CometChat React Sample App

CometChat Kitchen Sink Sample App (built using CometChat UI Kits) is a fully functional real-time messaging app capable of private (one-on-one), group messaging, voice & video calling.
Explore the docs »

Report Bug

Platform Language Version

Table of Contents

About The Project

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.

Built With

Getting Started

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.

Dependencies

  • CometChat - Sign up for CometChat and create an app to obtain your keys and other credentials

  • npm

    npm install npm@latest -g

Installing

  1. Clone the repo

    git clone https://github.com/cometchat-pro/cometchat-chat-sample-app-react.git -b v4

  2. Change to the working directory

    cd cometchat-chat-sample-app-react

  3. Install dependencies via NPM

    npm install

  4. Replace APP_ID, REGION and AUTH_KEY with your CometChat App ID, Region and Auth Key in src/constants.ts file.

export const COMETCHAT_CONSTANTS = {
		APP_ID: "APP_ID",
		REGION: "REGION",
		AUTH_KEY: "AUTH_KEY",
};


<!-- USAGE EXAMPLES -->

## Usage

This app contains all features offered by CometChat through its UI Kit. [Read more about the React UI Kit here.](https://www.cometchat.com/docs/v4/react-uikit/overview)

### Run project locally

```sh
npm start

To learn about React UI Kit Integration, please click here.

Help

To learn more about our UI kits, visit our documentation.

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.

Contributing

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!

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

Support

Please connect with our real time support via the CometChat Dashboard.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About Authors

This project is created & maintained by:
⚔️ @priyadarshininadar 🛡
⚔️ @juhi-saha 🛡
⚔️ @raj-dubey 🛡

The names and logos for CometChat are trademarks of CometChat, Inc.

We love open source software! See our other projects or sign up with us to start using our product.