{"id":19417988,"url":"https://github.com/americanexpress/one-app-dev-proxy","last_synced_at":"2025-04-24T13:34:14.719Z","repository":{"id":38174276,"uuid":"223457634","full_name":"americanexpress/one-app-dev-proxy","owner":"americanexpress","description":"✨ Proxy requests to remote servers locally while also allowing for an express middleware to be provided and applied to all requests ","archived":true,"fork":false,"pushed_at":"2024-05-15T10:26:15.000Z","size":1068,"stargazers_count":6,"open_issues_count":0,"forks_count":4,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-14T12:53:24.173Z","etag":null,"topics":["dev-proxy","express","express-middleware","nodejs","one-app","proxy-requests"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/americanexpress.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-22T17:58:18.000Z","updated_at":"2024-05-15T10:27:00.000Z","dependencies_parsed_at":"2023-11-07T15:34:52.879Z","dependency_job_id":"4b4d7b22-29f9-46c4-b7ed-b9e8c2daa97d","html_url":"https://github.com/americanexpress/one-app-dev-proxy","commit_stats":{"total_commits":48,"total_committers":12,"mean_commits":4.0,"dds":0.6041666666666667,"last_synced_commit":"40fb76f25194eb441dd45f4f4006e6a115c53f1a"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americanexpress%2Fone-app-dev-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americanexpress%2Fone-app-dev-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americanexpress%2Fone-app-dev-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americanexpress%2Fone-app-dev-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/americanexpress","download_url":"https://codeload.github.com/americanexpress/one-app-dev-proxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250636519,"owners_count":21463096,"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":["dev-proxy","express","express-middleware","nodejs","one-app","proxy-requests"],"created_at":"2024-11-10T13:12:19.146Z","updated_at":"2025-04-24T13:34:14.241Z","avatar_url":"https://github.com/americanexpress.png","language":"JavaScript","readme":"\u003ch1 align=\"center\"\u003e\n\n  [One App is now InnerSource](https://github.com/americanexpress/one-app/issues/1393)\n\n  \u003chr/\u003e\n\n  \u003cimg src='https://github.com/americanexpress/one-app-dev-proxy/raw/main/one-app-dev-proxy.png' alt=\"One App Dev Proxy - One Amex\" width='50%'/\u003e\n\u003c/h1\u003e\n\n[![npm](https://img.shields.io/npm/v/@americanexpress/one-app-dev-proxy)](https://www.npmjs.com/package/@americanexpress/one-app-dev-proxy)\n\n\u003e Proxy requests to remote servers locally while also allowing for an [express](https://expressjs.com) middleware to be provided and applied to all requests.\n\n## 📖 Table of Contents\n\n* [Features](#-features)\n* [Usage](#-usage)\n* [API](#-api)\n* [contributing](#-contributing)\n\n## ✨ Features\n\n* Proxy requests to remote servers locally.\n* Add an [express](https://expressjs.com) middleware applied to all requests.\n\n## 🤹‍ Usage\n\n### Installation\n\n```bash\nnpm i @americanexpress/one-app-dev-proxy -D\n```\n\nLook at the different `options` you can use under the [API](#API) section.\n\n```js\nimport oneAppDevProxy from '@americanexpress/one-app-dev-proxy';\n\noneAppDevProxy({\n  useMiddleware: true,\n  pathToMiddleware: path.join(__dirname, '../../.dev/middleware'),\n  remotes: { api: 'https://api.com' },\n});\n```\n\n## 🎛️ API\n\n## oneAppDevProxy( [options] )\n\n### options\n\nType: `object`\n\nprovide the options below to start the mock services.\n\n#### useMiddleware\n\nType: `boolean`\n\nDefault: `false`\u003cbr\u003e\nprovides the option of whether to apply provided middleware to `one-app-dev-proxy` server.\n\n#### pathToMiddleware\n\nType: `string`\npath to a file exporting an express middleware function by the HTTP_PROXY environment variable.\n\n#### remotes\n\nType: `object`\n\nDefault: `{}`\u003cbr\u003e\nConfiguration object containing paths `one-app-dev-proxy` should serve and where requests coming to those paths should be proxied to. Used if `pathToMiddleware` is not provided.\n\n**Note**: one-app-dev-proxy respects the `HTTP_PROXY` / `http_proxy`,  `HTTPS_PROXY` / `https_proxy`,\nand `NO_PROXY` / `no_proxy` environment variables and will use those accordingly when making\nrequests to remotes provided in the `remotes` option.\n\n\n## 🏆 Contributing\n\nWe welcome Your interest in the American Express Open Source Community on Github.\nAny Contributor to any Open Source Project managed by the American Express Open\nSource Community must accept and sign an Agreement indicating agreement to the\nterms below. Except for the rights granted in this Agreement to American Express\nand to recipients of software distributed by American Express, You reserve all\nright, title, and interest, if any, in and to Your Contributions. Please [fill\nout the Agreement](https://cla-assistant.io/americanexpress/one-app-dev-proxy).\n\nPlease feel free to open pull requests and see [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to get started contributing.\n\n## 🗝️ License\n\nAny contributions made under this project will be governed by the [Apache License\n2.0](https://github.com/americanexpress/one-app-dev-proxy/blob/main/LICENSE.txt).\n\n## 🗣️ Code of Conduct\n\nThis project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md).\nBy participating, you are expected to honor these guidelines.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famericanexpress%2Fone-app-dev-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famericanexpress%2Fone-app-dev-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famericanexpress%2Fone-app-dev-proxy/lists"}