|
| 1 | +# Table of Content |
| 2 | + |
| 3 | +- [About](#about) |
| 4 | +- [Requirements](#requirements) |
| 5 | +- [Screenshots](#screenshots) |
| 6 | +- [Features](#features) |
| 7 | +- [How to launch](#how-to-launch) |
| 8 | + * [1. Install Node.js and NPM integration](#1-install-nodejs-and-npm-integration) |
| 9 | + * [2. Run on development server](#4-run-on-development-server) |
| 10 | + + [2.1 Get application credentials](#21-get-application-credentials) |
| 11 | + + [2.2 Set application credentials](#22-set-application-credentials) |
| 12 | + + [2.3 Run the application](#23-run-the-application) |
| 13 | +- [Documentation](#documentation) |
| 14 | +- [License](#license) |
| 15 | + |
| 16 | +# About |
| 17 | +[](#about) |
| 18 | +QuickBlox UIKit React Sample |
| 19 | + |
| 20 | +This is a code sample for [QuickBlox](http://quickblox.com/) platform. It is a great way for developers using QuickBlox platform to learn how to integrate private and group chat, add text and image attachments sending into your application. |
| 21 | + |
| 22 | +# Requirements |
| 23 | +[](#requirements) |
| 24 | + |
| 25 | +The minimum requirements for QuickBlox UIKit for React sample are: |
| 26 | + |
| 27 | +- JS QuickBlox SDK v2.15.5 |
| 28 | +- QuickBlox React UIKit library v0.1.2 |
| 29 | +- React JS v.18.0 |
| 30 | +- TypeScript v.4.9.3 |
| 31 | + |
| 32 | +# Screenshots |
| 33 | +1. Sign In page; |
| 34 | + |
| 35 | +  |
| 36 | + |
| 37 | +2. Sign Up page; |
| 38 | + |
| 39 | +  |
| 40 | + |
| 41 | +3. UIKit; |
| 42 | + |
| 43 | +  |
| 44 | + |
| 45 | +# Features |
| 46 | + |
| 47 | +* Sign in/Sign up and Log out |
| 48 | +* Set up custom theme |
| 49 | +* Send and receive message/attachment |
| 50 | +* Create and leave a 1-to-1 and group chat |
| 51 | +* Create a public chat |
| 52 | +* Display users who have received/read the message |
| 53 | +* Mark messages as read/delivered |
| 54 | +* Send typing indicators |
| 55 | +* List and delete chats |
| 56 | +* Display chat history |
| 57 | +* Display a list with chat participants |
| 58 | + |
| 59 | +# How to launch |
| 60 | +## 1. Install Node.js and NPM integration |
| 61 | + |
| 62 | +You should use QuickBlox JavaScript SDK and QuickBlox UIKit with server-side applications on NodeJS through the native node package. |
| 63 | +Just install the package in your application project: |
| 64 | + |
| 65 | +Navigate the current project folder ***\samples\react-chat*** and type |
| 66 | + |
| 67 | +```bash |
| 68 | +npm install |
| 69 | +``` |
| 70 | + |
| 71 | +## 2. Run on development server |
| 72 | + |
| 73 | +### 2.1 Get application credentials |
| 74 | + |
| 75 | +QuickBlox application includes everything that brings messaging right |
| 76 | +into your application - chat, video calling, users, push notifications, |
| 77 | +etc. To create a QuickBlox application, follow the steps below: |
| 78 | + |
| 79 | +1. Register a new account following [this |
| 80 | + link](https://admin.quickblox.com/signup). Type in your email and |
| 81 | + password to sign in. You can also sign in with your Google or Github |
| 82 | + accounts. |
| 83 | +2. Create the app clicking **New app** button. |
| 84 | +3. Configure the app. Type in the information about your organization |
| 85 | + into corresponding fields and click **Add** button. |
| 86 | +4. Go to **Dashboard =\> *YOUR\_APP* =\> Overview** section and copy |
| 87 | + your **Application ID**, **Authorization Key**, **Authorization |
| 88 | + Secret**, and **Account Key**. |
| 89 | + |
| 90 | +### 2.2 Set application credentials |
| 91 | + |
| 92 | +Before run a code sample: |
| 93 | +1. get appId, authKey, authSecret, and accountKey |
| 94 | +2. put these values in file **QBconfig.ts** following **samples =\> |
| 95 | + react-chat =\> src\** directory. |
| 96 | + |
| 97 | + TypeScript |
| 98 | +```ts |
| 99 | + export const QBconfig = { |
| 100 | + credentials: { |
| 101 | + appId: '', |
| 102 | + authKey: '', |
| 103 | + authSecret: '', |
| 104 | + accountKey: '' |
| 105 | + } |
| 106 | + } |
| 107 | +``` |
| 108 | + |
| 109 | +### 2.3 Run the application |
| 110 | + |
| 111 | +Run `npm start` for a dev server. Navigate to `http://localhost:3000/`. The app will automatically reload if you change any of the source files. |
| 112 | + |
| 113 | +# Documentation |
| 114 | +[](#documentation) |
| 115 | +Sample documentation is available [here](https://docs.quickblox.com/docs/react-uikit). |
| 116 | + |
| 117 | +# License |
| 118 | +[](#license) |
| 119 | +MIT License [here](https://github.com/QuickBlox/react-ui-kit/blob/main/LICENSE.md). |
| 120 | + |
| 121 | +Copyright © 2023 QuickBlox |
0 commit comments