{"id":26064808,"url":"https://github.com/syncano/syncano-socket-volatile-chat","last_synced_at":"2026-06-15T21:31:41.239Z","repository":{"id":77440733,"uuid":"125351997","full_name":"Syncano/syncano-socket-volatile-chat","owner":"Syncano","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-04T08:25:22.000Z","size":166,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-11-09T08:28:19.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/Syncano.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":"2018-03-15T10:38:55.000Z","updated_at":"2018-04-04T08:25:23.000Z","dependencies_parsed_at":"2023-02-26T10:45:15.181Z","dependency_job_id":null,"html_url":"https://github.com/Syncano/syncano-socket-volatile-chat","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Syncano/syncano-socket-volatile-chat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-volatile-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-volatile-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-volatile-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-volatile-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syncano","download_url":"https://codeload.github.com/Syncano/syncano-socket-volatile-chat/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-volatile-chat/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34381759,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-03-08T18:49:25.034Z","updated_at":"2026-06-15T21:31:41.232Z","avatar_url":"https://github.com/Syncano.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# volatile-chat\n\n[![CircleCI](https://circleci.com/gh/Syncano/syncano-socket-volatile-chat.svg?style=svg)](https://circleci.com/gh/Syncano/syncano-socket-volatile-chat)\n\n`version:` **0.0.1**\n\nVolatile chat socket using using Syncano realtime feature\n\nTo install, run:\n\n```\nnpx s add volatile-chat\n```\n\n## Endpoints\n\n### send-message-group\n\nEndpoint to send message to a room\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| _user_key | string | Token of user sending message (Optional) | messageFrom@gmail.com\n| username | string | Name of the User (Required only when user token not sent). | Nik\n| message_text | string | Content of the message. | How are you doing.\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"message_text\": \"How are you doing\",\n  \"username\": \"Nik\"\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"message\": \"Failed to publish message\"\n}\n```\n\n### send-message-private\n\nEndpoint to send private message to user\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| message_text | string | Chat message | How are you\n| _user_key | string | Token of user sending message | messageFrom@gmail.com\n| message_to | string | Username of user to receive message | messageTo@gmail.com\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"message_text\": \"How are you doing\",\n  \"message_to\": \"messageTo@gmail.com\"\n  \"message_from\": \"messageFrom@gmail.com\"\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"message\": \"Failed to send message\"\n}\n```\n\n### group-chat\n\nEndpoint to subcribe to poll for a group messages\n\n### private-chat\n\nEndpoint to listen to user private message\n\n\n### Contributing\n\n#### How to Contribute\n  * Fork this repository\n  * Clone from your fork\n  * Make your contributions (Make sure your work is well tested)\n  * Create Pull request from the fork to this repo\n\n#### Setting up environment variables\n  * Create a `.env` on parent folder\n  * Copy contents of `.env-sample` file to newly created `.env` file and assign appropriate values to the listed variables.\n\n#### Testing\n  * Ensure all your test are written on the `test` directory\n  * Use the command `npm test` to run test\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-volatile-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyncano%2Fsyncano-socket-volatile-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-volatile-chat/lists"}