https://github.com/blimpio/boards-sockets

WebSockets server for Blimp Boards
https://github.com/blimpio/boards-sockets

Last synced: about 10 hours ago
JSON representation

WebSockets server for Blimp Boards

• Host: GitHub
• URL: https://github.com/blimpio/boards-sockets
• Owner: blimpio
• License: agpl-3.0
• Created: 2014-02-19T01:57:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-06-09T18:51:04.000Z (over 10 years ago)
• Last Synced: 2024-03-26T11:50:24.304Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 387 KB
• Stars: 3
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# boards-sockets

Web sockets implementation for boards-sockets using socket.io.

#### Running

```bash

$ npm install

$ node index.html

```

Open browser http://localhost:8000

### Backend Messages

This service will receive messages from boards-backend via the RedisStore used by Socket.io. We have two distinct rooms for all communication one for User events and another for Account events.

#### Room Names

Every message should be targeted to a specific room. Rooms allow us to target only specific users. If we don't specify a room the message will arrive to all users.

User room name: `'u' + `

Account room name: `'a' + `

#### Browser event

Every message will use the `message` event type which will be listened to by the client side application. Here's an example using [socket.io-announce](https://github.com/GetBlimp/socket.io-announce).

```python

announce = Announce()

announce.emit('message', {...}, room='u1')

```

#### Payload

The following is an example payload.

```json

{

	"data_type": "notification",

	"method": "create",

	"data": {...}

}

```

##### `data_type`:

`user`, `account`, `board`, `stack`, `card`, `comment`, `notification`, `user_setting`, `account_setting`.

##### `method`:

`create`, `update`, `delete`.

##### `data`:

The data field can only contain a JSON object.