{"id":19314056,"url":"https://github.com/maxleiko/ws-broadcast","last_synced_at":"2025-04-22T16:31:41.406Z","repository":{"id":25914520,"uuid":"29355410","full_name":"maxleiko/ws-broadcast","owner":"maxleiko","description":"Broadcast messages from a client to every other connected clients (without echoing to the sender)","archived":false,"fork":false,"pushed_at":"2017-05-02T12:59:40.000Z","size":54,"stargazers_count":10,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T01:13:37.489Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxleiko.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":"2015-01-16T15:55:31.000Z","updated_at":"2021-11-21T01:06:28.000Z","dependencies_parsed_at":"2022-08-24T14:16:58.897Z","dependency_job_id":null,"html_url":"https://github.com/maxleiko/ws-broadcast","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxleiko%2Fws-broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxleiko%2Fws-broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxleiko%2Fws-broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxleiko%2Fws-broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxleiko","download_url":"https://codeload.github.com/maxleiko/ws-broadcast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250277200,"owners_count":21404007,"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":"2024-11-10T00:42:07.052Z","updated_at":"2025-04-22T16:31:41.165Z","avatar_url":"https://github.com/maxleiko.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ws-broadcast\nBroadcast messages from a client to every other connected clients (without echoing to the sender)  \nThe messages can be clustered in \"rooms\" by using different `/path` (see \"Handles room\" below)\n\n### Install\n```sh\nnpm i -g ws-broadcast\n```\n\nYou can now start a `ws-broacast` or `wsb` in your any shell.\n\n\n### Usage\n```sh\nws-broadcast\n```\n\nThis will start an `express` Web server and a `WebSocket` server on default `0.0.0.0:3000`  \n\n### Change port\nIf you want to change the **default port** use:\n```sh\nPORT=9090 ws-broadcast\n```\n\n### Handles rooms\nYou can split clients into groups by connecting them to a different path  \nYou just have to append a `/path` to the server url:\n\n`ws://localhost:9001/myRoom`\n\nBy doing so, clients will only be able to communicate with other clients from the same room.  \nThere is no way for clients to communicate with other rooms.\n\n### Docker image\nYou can also start a `ws-broadcast` using Docker:\n```sh\ndocker run -d maxleiko/ws-broadcast\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxleiko%2Fws-broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxleiko%2Fws-broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxleiko%2Fws-broadcast/lists"}