https://github.com/guardian/content-api-local-proxy
Proxying requests to live and preview CAPI. Handling auth, so you don't have to!
https://github.com/guardian/content-api-local-proxy
testing
Last synced: 6 months ago
JSON representation
Proxying requests to live and preview CAPI. Handling auth, so you don't have to!
- Host: GitHub
- URL: https://github.com/guardian/content-api-local-proxy
- Owner: guardian
- Created: 2019-08-30T10:55:42.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T12:11:04.000Z (about 2 years ago)
- Last Synced: 2025-03-28T11:16:29.456Z (over 1 year ago)
- Topics: testing
- Language: JavaScript
- Homepage:
- Size: 505 KB
- Stars: 2
- Watchers: 41
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Content API Local Proxy
A local proxy to CAPI that handles authentication.
**FOR LOCAL USE ONLY**
See [documentation for the Content API](https://open-platform.theguardian.com/documentation/) for relevant endpoints, and how to query and filter the response from CAPI.
## Running
💻 Clone repo `git clone git@github.com:guardian/content-api-local-proxy.git`
🔌 Run `./script/setup`
📝 Fill in `.env` – see the template in `.env.example`. API keys can be acquired at `https://bonobo.capi.gutools.co.uk/register/developer`.
🎭 [For preview] Make sure you have up-to-date AWS credentials for the 'Content API' account.
🔌 Run `./script/start`
🌍 Open `https://capi-proxy.local.dev-gutools.co.uk` in your browser
## Developing
🔌 Run `./script/start-dev` to watch for changes and reload the server
🌍 Open `https://capi-proxy.local.dev-gutools.co.uk` in your browser