{"id":21466558,"url":"https://github.com/permafrost-dev/ray-proxy","last_synced_at":"2025-07-15T05:30:49.858Z","repository":{"id":36985996,"uuid":"329621801","full_name":"permafrost-dev/ray-proxy","owner":"permafrost-dev","description":"a proxy for the Ray app to allow debugging of payloads","archived":false,"fork":false,"pushed_at":"2024-11-05T01:56:24.000Z","size":129,"stargazers_count":7,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-09T05:20:03.969Z","etag":null,"topics":["debugging","javascript","npm-package","proxy","ray","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/permafrost-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"permafrost-dev","custom":"https://permafrost.dev/open-source"}},"created_at":"2021-01-14T13:21:20.000Z","updated_at":"2024-10-11T14:57:02.000Z","dependencies_parsed_at":"2023-12-31T14:46:19.361Z","dependency_job_id":null,"html_url":"https://github.com/permafrost-dev/ray-proxy","commit_stats":{"total_commits":111,"total_committers":2,"mean_commits":55.5,"dds":"0.18918918918918914","last_synced_commit":"03060663a509ea98a9ba697bb254d908bc576f62"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Fray-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Fray-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Fray-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Fray-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/permafrost-dev","download_url":"https://codeload.github.com/permafrost-dev/ray-proxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226017177,"owners_count":17560466,"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":["debugging","javascript","npm-package","proxy","ray","typescript"],"created_at":"2024-11-23T08:14:37.052Z","updated_at":"2024-11-23T08:14:37.786Z","avatar_url":"https://github.com/permafrost-dev.png","language":"TypeScript","funding_links":["https://github.com/sponsors/permafrost-dev","https://permafrost.dev/open-source"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://static.permafrost.dev/images/ray-proxy/ray-proxy-logo-256x256.png\" alt=\"ray-proxy\" height=\"200\" style=\"block\"\u003e\n    \u003cbr\u003e\u003cbr\u003e\n    \u003ccode style=\"font-size:3.0rem;\"\u003e\u003cstrong\u003eray-proxy\u003c/strong\u003e\u003c/code\u003e\n    \u003cbr\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://shields.io/npm/v/ray-proxy\" alt=\"npm version\"\u003e \u003cimg src=\"https://img.shields.io/npm/dt/ray-proxy.svg\" alt=\"npm downloads\"\u003e \u003cimg src=\"https://shields.io/github/license/permafrost-dev/ray-proxy\" alt=\"license\"\u003e \u003cimg src=\"https://github.com/permafrost-dev/ray-proxy/workflows/Run%20Tests/badge.svg\" alt=\"test status\"\u003e \u003cimg src=\"https://codecov.io/gh/permafrost-dev/ray-proxy/branch/main/graph/badge.svg?token=YW2BTKSNEO\"/\u003e\n\u003c/p\u003e\n\n# ray-proxy\n\n---\n\nThis project acts as a proxy in front of [Ray](https://myray.app) for debugging the data sent between your app and the Ray app.\n\nInternally, this project uses the [fastify](https://www.fastify.io/) package for the http service and the [axios](https://github.com/axios/axios) package to forward the incoming requests to Ray.\n\nBy default, the proxy will run on port `23517` and forward the requests to `localhost` on port `23516`.\n\n_This is a work in progress and may change considerably without notice._\n\n---\n\n![screenshot](https://static.permafrost.dev/images/ray-proxy/screenshot-01.png)\n\n---\n\n## Installation\n\n```bash\nnpx ray-proxy\n```\n\n...or install it into a project:\n\n```bash\nnpm install ray-proxy --save-dev\n\n./node_modules/.bin/ray-proxy\n```\n\n## Precompiled Standalone Build\n\nYou can find a precompiled, standalone build on the [releases](../../releases) page under \"Assets\", named something like `ray-proxy-standalone-X.Y.Z.tgz` where `X.Y.Z` is the latest release version.\n\nAll you need to run the standalone build is a NodeJS v12+ installation.\n\n## Configuration\n\nUpon starting, `ray-proxy` looks for the file `ray-proxy.config.js` in the same directory as your current project's root directory.\n\nThis is optional and the application will use the default settings if no configuration file is found.\n\n_Example:_\n\n```js\n// ray-proxy.config.js\n\nmodule.exports = {\n    hostName: 'localhost',\n    hostPort: 23516,\n    proxyPort: 23517,\n    displayBanner: true,\n}\n```\n\n---\n\n## Development Instructions\n\n```bash\n# install required packages\nnpm install\n\n# run in development mode\nnpm run dev\n\n# or run in production mode:\nnpm run prod\n```\n\nOr you can build and run manually:\n\n```bash\nnpm run build:prod # or build:dev\n\nnode run dist/ray-proxy.js\n```\n\n---\n\n## Testing\n\nThis package uses jest for unit tests. To run the test suite, run:\n\n`npm run test`\n\n---\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Patrick Organ](https://github.com/patinthehat)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermafrost-dev%2Fray-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpermafrost-dev%2Fray-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermafrost-dev%2Fray-proxy/lists"}