Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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 2 months ago
JSON representation

A CLI chat, built with Chatkit

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
```