{"id":13424973,"url":"https://github.com/kthwaite/fastapi-websocket-broadcast","last_synced_at":"2025-03-15T19:32:24.064Z","repository":{"id":41366403,"uuid":"170907929","full_name":"kthwaite/fastapi-websocket-broadcast","owner":"kthwaite","description":"Websocket 'broadcast' demo using FastAPI/Starlette","archived":false,"fork":false,"pushed_at":"2024-08-19T13:00:37.000Z","size":71,"stargazers_count":132,"open_issues_count":3,"forks_count":23,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-03T07:01:59.358Z","etag":null,"topics":["async","fastapi","python3","starlette","websocket"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kthwaite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-15T18:08:36.000Z","updated_at":"2024-08-31T18:31:48.000Z","dependencies_parsed_at":"2024-09-03T07:02:20.389Z","dependency_job_id":"41deef38-0d77-4000-9770-eb529029aa09","html_url":"https://github.com/kthwaite/fastapi-websocket-broadcast","commit_stats":null,"previous_names":["cthwaite/fastapi-websocket-broadcast"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kthwaite%2Ffastapi-websocket-broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kthwaite%2Ffastapi-websocket-broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kthwaite%2Ffastapi-websocket-broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kthwaite%2Ffastapi-websocket-broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kthwaite","download_url":"https://codeload.github.com/kthwaite/fastapi-websocket-broadcast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221609553,"owners_count":16851387,"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":["async","fastapi","python3","starlette","websocket"],"created_at":"2024-07-31T00:01:01.409Z","updated_at":"2024-10-27T00:30:16.702Z","avatar_url":"https://github.com/kthwaite.png","language":"Python","funding_links":[],"categories":["Projects"],"sub_categories":["Open Source Projects"],"readme":"# fastapi-websocket-broadcast\n\nAn example of the familiar 'chat' websocket demo app, implemented in [FastAPI](https://github.com/tiangolo/fastapi) / [Starlette](https://github.com/encode/starlette).\n\nRun with\n\n```\nuvicorn app:app\n```\n\nAnd then point your browser to [http://localhost:8000](http://localhost:8000). REST API documentation is available under the `/docs` endpoint.\n\n\n## Websocket interface\n\nData from the server is JSON in the form\n\n```json\n{\n    \"type\": ...,\n    \"data\": {\n        ...\n    }\n}\n```\n\nWhere `type` is one of:\n\n- **ROOM_JOIN** - sent to a user on successfully joining the chatroom\n- **USER_JOIN** - sent to all chatroom users when a new user joins the chatroom\n- **USER_LEAVE** - sent to all chatroom users when a user leaves the chatroom \n- **ERROR** - sent to one or more users in the event of a server error\n- **MESSAGE** - chat message from one user, broadcast to all chatroom users\n- **WHISPER** - private message from one user to another\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkthwaite%2Ffastapi-websocket-broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkthwaite%2Ffastapi-websocket-broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkthwaite%2Ffastapi-websocket-broadcast/lists"}