https://github.com/notenoughneon/nekocafe

Web chat room :cat: :speech_balloon:
https://github.com/notenoughneon/nekocafe

Last synced: about 1 month ago
JSON representation

Web chat room :cat: :speech_balloon:

• Host: GitHub
• URL: https://github.com/notenoughneon/nekocafe
• Owner: notenoughneon
• License: mit
• Created: 2015-01-29T05:05:21.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-08-12T22:16:02.000Z (over 7 years ago)
• Last Synced: 2024-05-03T23:51:45.769Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 392 KB
• Stars: 18
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-choo - nekocafe - Web chat room :cat: :speech_balloon:. (Uncategorized / Uncategorized)

README

        
# nekocafe

Web chat room 🐱 💬

[![npm](https://img.shields.io/npm/v/nekocafe.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/nekocafe)

![screenshot](IMG_0717.png)

![screenshot](IMG_0718.png)

A chat server using websockets. Send your friends the url and chat through the browser.

* designed for mobile

* no passwords/registration

* 100 line backlog

* hotlinked urls

* embedded images, youtubes, tweets

## Installing

```

npm install -g nekocafe

```

## Running

```

nekocafe 

```

For https mode, pass your certificates on the command line:

```

nekocafe   

```

## Development

`npm run dev` to build client side (outputs to dist/)

`node lib/server.js ` to run the server (does not need to restart after client rebuild)

or `npm run start` to run on port 80

## Protocol

### Client

#### `nick, name: string`

Set nick of the connecting client. Required after connecting.

#### `replay`

Request server to replay all messages in the backlog. Not required.

#### `message, text: string`

Send a message to the chatroom.

#### `file, {name: string, type: string, data: blob}`

Send a file attachment. `type` is the mimetype which will be used to embed the media, if possible.

### Server

#### `users, Array<{id: string, nick: string}>`

The list of connected users. Sent after a client connects.

#### `join, {id: string, nick: string}`

Sent when a user joins.

#### `part, {id: string, nick: string}`

Sent when a user leaves.

#### `time, now: number`

Current server time, sent every 15 seconds. Used to provide accurate timestamp deltas despite clock drift between client/server.

#### `message, {time: number, nick: string, message: string, embeds: Array<{type: ('html'|'tweet'), html?: string, id?: string}>}`

A message sent to the chatroom. HTML is not stripped from the content. `embeds` contains a list of parsed embed content. 

## Changelog

* 1.3.0 - file uploads

* 1.2.0 - embedded youtubes, tweets

* 1.1.0 - embedded images, remember username/prefs, performance improvements

* 1.0.0 - first release