https://github.com/pusher/chatkit-command-line-chat
A CLI chat, built with Chatkit
https://github.com/pusher/chatkit-command-line-chat
Last synced: about 1 year ago
JSON representation
A CLI chat, built with Chatkit
- Host: GitHub
- URL: https://github.com/pusher/chatkit-command-line-chat
- Owner: pusher
- Archived: true
- Created: 2018-05-22T16:33:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-16T04:55:51.000Z (about 6 years ago)
- Last Synced: 2025-04-20T23:46:18.781Z (over 1 year ago)
- Language: JavaScript
- Size: 337 KB
- Stars: 41
- Watchers: 9
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pusher Relay Chat 💬
> Terminal chat application built with Pusher Chatkit! 🚀
## Requirements
Prior to running this locally, you'll need a Chatkit instance.
To create one, navigate to the [Pusher Dashboard](https://dash.pusher.com/), login and hit **create new**, enter a name for the instance. Make sure to note down your **Instance Locator** and **Secret Key**, located under the `keys` tab, as we'll need this later!
## Install
### Install dependencies
```
npm install
```
### Server
Edit `server.js`, replacing `YOUR_INSTANCE_LOCATOR` and `YOUR_KEY` with your **Instance Locator** and **Secret Key** respectively.
Run the auth server via:
```
node server.js
```
### Client
Create a user/room via the inspector in the Pusher Dashboard.
Edit `client.js`, replacing `YOUR_INSTANCE_LOCATOR` with your **Instance Locator**.
Run the client via:
```
node client.js
```