You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 13, 2024. It is now read-only.
This repository contains the code for the Team Chat Reference Application hosted on [PubNub Chat Docs Page](https://www.pubnub.com/docs/chat/quickstart#quickstart).
5
+
This repository contains the code for the Team Chat web reference application hosted on the [PubNub Chat Docs Page](https://www.pubnub.com/docs/chat/quickstart#quickstart). You can download the project to run on your local machine, and explore the code to see how we built it.
6
+
7
+

6
8
7
9
The application demonstrates how to build a chat application using:
10
+
8
11
- PubNub
9
12
- TypeScript
10
13
- React
11
14
- Redux
12
15
13
-

14
-
15
16
## Requirements
16
17
17
-
*[Node.js](https://nodejs.org/en/)
18
-
* PubNub Account (Free)
18
+
-[Node.js](https://nodejs.org/en/)
19
+
-[PubNub Account](#pubnub-account) (*Free*)
20
+
21
+
## PubNub Account
22
+
23
+
To run this application you must obtain publish and subscribe keys from your PubNub Account. If you don't already have an account, you can [create one for free](https://dashboard.pubnub.com/).
24
+
25
+
1. Sign in to your [PubNub Dashboard](https://dashboard.pubnub.com/).
26
+
27
+
1. Click **Create New App**.
19
28
20
-
### PubNub Account
29
+
1. Give your app a name, and select **Chat App** as the app type.
21
30
22
-
If you don't already have an account, you can [create one for free](https://dashboard.pubnub.com/).
31
+
1. Select a region to store your user data (e.g. *Portland*).
23
32
24
-
1.Sign in to your PubNub [Admin Dashboard](https://dashboard.pubnub.com/), click Create New App for PubNub Chat and give your app a name.
33
+
1.Click **Create**.
25
34
26
-
1.Select your new app, then click its keyset.
35
+
1.Click your new app to open its settings, then click its keyset.
27
36
28
-
1. Locate the Publish and Subscribe keys. You'll need these keys to include in this project.
37
+
1. Locate the *Publish* and *Subscribe* keys. You'll need these keys to include in this project.
29
38
30
-
## Building the project
39
+
## Running the project
31
40
32
41
1. Clone the GitHub repository.
33
42
@@ -42,16 +51,16 @@ If you don't already have an account, you can [create one for free](https://dash
42
51
npm install
43
52
```
44
53
45
-
1. Run the project in your local environment. You may be asked to input your PubNub keys and populate sample data ifyou are running the app for the first time.
54
+
1. Run the project in your local environment. If you are running the app for the first time, enter your PubNub keys to begin populating sample data.
46
55
47
56
```bash
48
57
npm start
49
58
```
50
59
51
-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
60
+
A web browser should automatically open [http://localhost:3000](http://localhost:3000), and you can explore your very own Team Chat app!
52
61
53
62
## Further Information
54
63
55
-
Visit the [PubNub Chat Docs](https://www.pubnub.com/docs/chat) page for more information on how to use the React and Redux SDKs to add in-app chat to your applications.
64
+
Visit the [PubNub Chat Docs](https://www.pubnub.com/docs/chat) page for more information about how to use the React and Redux SDKs to add in-app chat to your applications.
56
65
57
-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). Special thanks to Elvis Wolcott and Mark Erikson.
66
+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). Special thanks to Martin Lagrange, Elvis Wolcott, and Mark Erikson.
0 commit comments