{"id":24535898,"url":"https://github.com/blimpllc/boards-sockets","last_synced_at":"2026-01-02T19:09:12.507Z","repository":{"id":14263018,"uuid":"16970774","full_name":"blimpllc/boards-sockets","owner":"blimpllc","description":"WebSockets server for Blimp Boards","archived":false,"fork":false,"pushed_at":"2014-06-09T18:51:04.000Z","size":396,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-19T19:19:30.664Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blimpllc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-19T01:57:13.000Z","updated_at":"2024-04-17T21:21:14.000Z","dependencies_parsed_at":"2022-09-05T21:51:02.293Z","dependency_job_id":null,"html_url":"https://github.com/blimpllc/boards-sockets","commit_stats":null,"previous_names":["blimpio/boards-sockets","blimpllc/boards-sockets"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fboards-sockets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fboards-sockets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fboards-sockets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fboards-sockets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blimpllc","download_url":"https://codeload.github.com/blimpllc/boards-sockets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809971,"owners_count":20351403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T13:27:27.943Z","updated_at":"2026-01-02T19:09:12.473Z","avatar_url":"https://github.com/blimpllc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# boards-sockets\n\nWeb sockets implementation for boards-sockets using socket.io.\n\n#### Running\n\n```bash\n$ npm install\n$ node index.html\n```\n\nOpen browser http://localhost:8000\n\n\n### Backend Messages\nThis 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.\n\n\n#### Room Names\nEvery 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.\n\nUser room name: `'u' + \u003cuser_id\u003e`\n\nAccount room name: `'a' + \u003caccount_id\u003e`\n\n\n#### Browser event\nEvery 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).\n\n```python\nannounce = Announce()\nannounce.emit('message', {...}, room='u1')\n```\n\n\n#### Payload\nThe following is an example payload.\n\n```json\n{\n\t\"data_type\": \"notification\",\n\t\"method\": \"create\",\n\t\"data\": {...}\n}\n```\n\n\n##### `data_type`:\n`user`, `account`, `board`, `stack`, `card`, `comment`, `notification`, `user_setting`, `account_setting`.\n\n\n\n##### `method`:\n`create`, `update`, `delete`.\n\n\n##### `data`:\nThe data field can only contain a JSON object.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fboards-sockets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblimpllc%2Fboards-sockets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fboards-sockets/lists"}