{"id":21944742,"url":"https://github.com/browserstack/ws-reconnect-proxy","last_synced_at":"2025-04-22T21:07:10.698Z","repository":{"id":37724834,"uuid":"379896399","full_name":"browserstack/ws-reconnect-proxy","owner":"browserstack","description":"Proxy Server that is between a ws server and a ws client. In case of either server / client disconnects graceful or otherwise - initiates/ supports reconnection . ","archived":false,"fork":false,"pushed_at":"2025-03-20T02:28:29.000Z","size":711,"stargazers_count":3,"open_issues_count":14,"forks_count":6,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-22T21:06:59.961Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-24T11:06:40.000Z","updated_at":"2024-06-05T07:54:06.000Z","dependencies_parsed_at":"2024-05-19T07:24:57.149Z","dependency_job_id":"3e0cd645-47c5-455c-870c-a3a8fce49b5a","html_url":"https://github.com/browserstack/ws-reconnect-proxy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fws-reconnect-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fws-reconnect-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fws-reconnect-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fws-reconnect-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/ws-reconnect-proxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250324687,"owners_count":21411946,"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-29T04:17:00.240Z","updated_at":"2025-04-22T21:07:10.674Z","avatar_url":"https://github.com/browserstack.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ws-reconnect-proxy\n\nProxy Server that is between a ws server and a ws client. In case of either server / client disconnects graceful or otherwise - initiates/ supports reconnection.\n\nRead more about [📝 design](docs/design.md)\n\n### README Contents:\n\n- [How to contribute](#how-to-contribute)\n- [Development Internals](#development-internals)\n\n### ✨ How to contribute\n\nWe are very happy to receive and merge your contributions into this repository!\n\nTo contribute via pull request, follow these steps:\n\n1. Create an issue describing the feature you want to work on (or\n   have a look at the [issues](https://github.com/browserstack/ws-reconnect-proxy/issues))\n2. Write your code, tests and format them with `npm run format`\n3. Create a pull request describing your changes\n\nYour pull request will be reviewed by a maintainer, who will get\nback to you about any necessary changes or questions.\n\n## ⚡️ Development Internals\n\n### 🔨 Installing Dependencies\n\nTo install dependencies\n\n```bash\nnpm install\n```\n\n### ✅ Running the Tests\n\nIn order to run the tests, make sure that you have installed dependencies:\n\n```bash\nnpm run test\n```\n\n### 🎨 Formatting\n\nTo reformat files execute\n\n```bash\nnpm run format\n```\n\n### 🚀 Run proxy\n\n🔧 Before, executing proxy create the `config.json` by running the following command:\n\n```bash\ncp lib/config/config.json.sample lib/config/config.json\n```\n\nAdditionally, you can configuration your proxy based on your needs. Refer here - [config.json.sample](lib/config/config.json.sample)\n\nThen execute proxy by running the following command:\n\n```bash\nnpm run start\n```\n\n_NOTE: By default it runs in `dev` environment you can configure your env by the following command:_\n\n```bash\nNODE_ENV=\u003cenv\u003e node cluster.js\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fws-reconnect-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fws-reconnect-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fws-reconnect-proxy/lists"}