Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Commit 66ccbcd

Browse files
author
Jeff Moore
committed
Releasing v0.10.2
1 parent 79fe142 commit 66ccbcd

26 files changed

+138
-173
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ node_modules
1111
# production
1212
/build
1313
/functions/build
14+
/website/build
1415

1516
# misc
1617
.DS_Store

README.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![Build Status](https://travis-ci.com/pubnub/typescript-ref-app-team-chat.svg?branch=master)](https://travis-ci.com/pubnub/typescript-ref-app-team-chat)
44

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.
5+
The team chat app demonstrates how to build a feature-rich chat and team collaboration application using [PubNub Chat](https://www.pubnub.com/docs/chat/quickstart). Learn how to manage users, join chat rooms, and send messages with PubNub. Learn how to build advanced features like profanity filtering, gifs, and link previews. You can download the project to run on your local machine, and explore the code to see how we built it.
66

7-
Check out the [documentation](http://pubnub.github.io/typescript-ref-app-team-chat) to learn about advanced features like profanity filtering, gifs, and link previews.
7+
Check out the [Team Chat Tutorial](https://pubnub.github.io/typescript-ref-app-team-chat/docs/introduction).
88

99
![alt text](team-chat-preview.png "Reference App")
1010

@@ -18,27 +18,7 @@ The application demonstrates how to build a chat application using:
1818
## Requirements
1919

2020
- [Node.js](https://nodejs.org/en/)
21-
- [PubNub Account](#pubnub-account) (*Free*)
22-
23-
## PubNub Account
24-
25-
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/).
26-
27-
1. Sign in to your [PubNub Dashboard](https://dashboard.pubnub.com/).
28-
29-
1. Click **Create New App**.
30-
31-
1. Give your app a name, and select **Chat App** as the app type.
32-
33-
1. Click **Create**.
34-
35-
1. Click your new app to open its settings, then click its keyset.
36-
37-
1. Enable the **Objects** feature. **Presence** and **PubNub Functions** should have been enabled when the keyset was created.
38-
39-
1. Select a region to store your user data (e.g. *US East*). **DO NOT** enable user, channel, or membership events.
40-
41-
1. Locate the *Publish* and *Subscribe* keys. You'll need these keys to include in this project.
21+
- [PubNub Account](https://dashboard.pubnub.com/)
4222

4323
## Running the project
4424

@@ -55,7 +35,7 @@ To run this application you must obtain publish and subscribe keys from your Pub
5535
npm install
5636
```
5737

58-
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.
38+
1. Start the project. You'll be asked to enter your chat app keys from the [PubNub Dashboard](https://dashboard.pubnub.com/). Note that Objects should be enabled and a region should be selected on the key.
5939
6040
```bash
6141
npm start
@@ -65,6 +45,6 @@ To run this application you must obtain publish and subscribe keys from your Pub
6545
6646
## Further Information
6747
68-
Checkout [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.
48+
For more information, head over to [Team Chat Tutorial](https://pubnub.github.io/typescript-ref-app-team-chat/docs/introduction) and get started building chat today.
6949
7050
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.

docs/assets/team-chat-preview.png

256 KB
Loading

docs/introduction.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
id: introduction
3+
title: Team Chat
4+
sidebar_label: Introduction
5+
---
6+
7+
The team chat app demonstrates how to build a feature-rich chat and team collaboration application. Learn how to manage users, join chat rooms, and send messages with PubNub. Get started by downloading the app code from [Github](https://github.com/pubnub/typescript-ref-app-team-chat).
8+
9+
![team chat preview](assets/team-chat-preview.png)
10+
11+
## Features
12+
13+
The team chat app comes preloaded with the following features:
14+
15+
- **Group messaging** that lets teams communicate in realtime, increasing productivity.
16+
- **User and channel metadata** so you can view channel details, member’s lists, and more without storing data in a separate database.
17+
- **User presence detection** to show who’s online or offline at any moment.
18+
- **Typing indicators** that add responsiveness and improve communication.
19+
- **GIPHY integration** so you can share GIFs and personalize your chats.
20+
- **Rich media** to share emojis and links, improving the end-user experience.
21+
- **Profanity filtering** to replace bad words in messages, keeping chats friendly for everyone.
22+
23+
## SDKs & Frameworks
24+
25+
The app is built using PubNub Chat SDKs and Frameworks for realtime messaging. It uses the following:
26+
27+
- [React](https://www.pubnub.com/docs/chat/react/setup) provides tools to leverage the PubNub JavaScript SDK within a React application.
28+
- [Redux](https://www.pubnub.com/docs/chat/redux/setup) manages state of data components inside an application.
29+
- [Javascript](https://www.pubnub.com/docs/web-javascript/pubnub-javascript-sdk) connects and communicates with the network.
30+
31+
For more information, head over to [PubNub Chat Documentation](https://www.pubnub.com/docs/chat/quickstart) and get started building chat today.

docs/quickstart/optional-features.md renamed to docs/optional-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: optional-features
3-
title: Optional Features
4-
sidebar_label: Optional Features
3+
title: Advanced Features
4+
sidebar_label: Advanced Features
55
---
66

77
Team Chat comes with additional rich features like link previews, gifs, and content moderation.

docs/quickstart/frameworks.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/quickstart/introduction.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/quickstart/run-locally.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

docs/run-locally.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: run-locally
3+
title: Running the App
4+
sidebar_label: Run Locally
5+
---
6+
7+
Follow the instructions below to run the app in your local environment.
8+
9+
## Requirements
10+
11+
- [Node.js](https://nodejs.org/en/)
12+
- [PubNub Account](https://dashboard.pubnub.com/)
13+
14+
## Running the project
15+
16+
1. Clone the GitHub repository.
17+
18+
```bash
19+
git clone https://github.com/pubnub/typescript-ref-app-team-chat-private.git
20+
```
21+
22+
1. Install the project.
23+
24+
```bash
25+
cd typescript-ref-app-team-chat
26+
npm install
27+
```
28+
29+
1. Start the project. You'll be asked to enter your chat app keys from the PubNub Dashboard. Note that Objects should be enabled and a region should be selected on the key.
30+
31+
```bash
32+
npm start
33+
```
34+
35+
A web browser should automatically open [http://localhost:3000](http://localhost:3000), and you can explore your very own Team Chat app!

docs/tutorial/conversation-members.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: conversation-members
33
title: Show Members in Conversation
4-
sidebar_label: Conversation Members
4+
sidebar_label: Show Members
55
---
66

77
Click the membership count at the top right of a conversation, and you’ll see the conversation’s member list.

docs/tutorial/joined-conversations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: joined-conversations
3-
title: Show Joined Conversations
4-
sidebar_label: Joined Conversations
3+
title: Show My Conversations
4+
sidebar_label: Show Conversations
55
---
66

77
Below your user info, you’ll find your list of conversations.

docs/tutorial/login.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: login
33
title: Log in with a User
4-
sidebar_label: User Login
4+
sidebar_label: Login
55
---
66

77
While the splash screen displays, the app is selecting a user for you, and retrieving the conversations to which your user is subscribed.

docs/tutorial/messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: messages
33
title: Send and Receive Messages
4-
sidebar_label: Messages
4+
sidebar_label: Send Messages
55
---
66

77
Along the top of the conversation pane, the app displays details about the conversation: a title, description, and membership and presence information.

docs/tutorial/overview.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,12 @@ sidebar_label: Overview
66

77
This tutorial convers how Team Chat’s key features are put together, and how you can add them in your own applications.
88
Each section focuses on one feature of the application.
9-
Although the sections build on each other, feel free to skip around and explore the features that interest you.
9+
Although the sections build on each other, feel free to skip around and explore the features that interest you.
10+
11+
- [Theming](/typescript-ref-app-team-chat/docs/tutorial/theming) to quickly customize the look and branding of your application
12+
- [Messaging](/typescript-ref-app-team-chat/docs/tutorial/messages) powered by PubNub
13+
- [Join Conversations](/typescript-ref-app-team-chat/docs/tutorial/join-conversation)
14+
- [Leave Conversations](/typescript-ref-app-team-chat/docs/tutorial/leave-conversation)
15+
- [Conversation Members](/typescript-ref-app-team-chat/docs/tutorial-conversation-members) including online/offline status using Presence
16+
- [Typing Indicators](/typescript-ref-app-team-chat/docs/tutorial/typing-indicators) let users know when another user is typing
17+
- [Profanity Filtering](/typescript-ref-app-team-chat/docs/profanity-filtering) to moderate messages with serverless PubNub functions

docs/tutorial/pubnub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: pubnub
33
title: Add PubNub to your App
4-
sidebar_label: PubNub Integration
4+
sidebar_label: Add PubNub Keys
55
---
66

77
When the app first loads, it runs the `main/App.tsx` component to initialize the [pubnub client](https://www.pubnub.com/docs/chat/reference/users#initialize-pubnub) with your publish and subscribe keys that are configured in the `.env` file.

docs/tutorial/sample-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: sample-data
33
title: Changing the Sample Data
4-
sidebar_label: Sample Data
4+
sidebar_label: Populate Data
55
---
66

77
When you run the app for the first time, it runs the `setup/populate.js` script to populate sample data for users, spaces, and memberships into your PubNub keys.

docs/tutorial/theming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: theming
33
title: Theming the Application
4-
sidebar_label: Theming
4+
sidebar_label: Setup Theming
55
---
66

77
Team Chat was built using the [System UI theme specification](https://system-ui.com/theme/).

docs/tutorial/typing-indicators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: typing-indicators
33
title: Typing Indicators
4-
sidebar_label: Typing Indicators
4+
sidebar_label: Send Typing Indicators
55
---
66

77
When someone is typing, the app displays a message showing the name of the user who is typing.

docs/tutorial/user-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: user-details
33
title: Show User Details
4-
sidebar_label: User Details
4+
sidebar_label: Show User Details
55
---
66

77
In the top left section of the UI, the app shows details for the current user.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "team-chat",
3-
"version": "0.10.1",
3+
"version": "0.10.2",
44
"description": "Team Chat - A Reference Application for PubNub with Typescript, React and Redux",
55
"license": "MIT",
66
"private": true,

0 commit comments

Comments
 (0)