https://github.com/guardian/pa-api-local-proxy
https://github.com/guardian/pa-api-local-proxy
testing
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/guardian/pa-api-local-proxy
- Owner: guardian
- Created: 2021-07-04T21:23:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-14T11:55:19.000Z (almost 5 years ago)
- Last Synced: 2026-01-30T01:22:20.379Z (5 months ago)
- Topics: testing
- Language: JavaScript
- Size: 34.2 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pa-api-local-proxy
Currently Press Association Browser has various URL's to request the specific data needed.
For example Teams, Match IDs, Scrorers, Goals, math dates.
Checking various data and results from Press Association api as a result can be tricky and laborious.
By using a local browser like this there is no need to be logged in via the Guardian account.
The aim to allow developers to run this api locally in order to test the data recieved from PA.
This api deals with all the various URLs and endpoints automatically for you.
By running this api locally, all the user needs to do is enter the data as input for the desired results.
This can be done with minimal hassle without the need know all the URLs for the various endpoints: this api does the routing for developers. No need to rememebr and copy and paste different URL for the various results.
`pa-api-local-proxy` provides an abstraction that makes it easy to write custom elements that:
- contains user-defined inputs to search PA for GoldenBoot scores by name, returning their goals scored and rank
- allows for searching Euro matches by date; returning all matches on that day (all teams, the match IDs)
## Setup
`npm` installs and sets up the project dependencies.
## Run Locally
Server:
-Must be in pa-api-local-proxy/server directory
- `node index.js` builds the project locally, spins up a webserver on http://localhost:5000
-alternatively watch for changes
- `nodemon` builds the project locally, spins up a webserver on http://localhost:5000, and watches for file changes. (https://www.npmjs.com/package/nodemon)
Client:
- `Liver Server` from within VS CODE as a plugin - spins up a webserver on http://127.0.0.1:5500/pa-api-local-proxy/client/index.html
alternatively must be in pa-api-local-proxy/client
- `open index.html` - to open the web page in local browser
## API - Key
- API key for Press Association - found in AWS services for Guardian employees
## Actions Available
Blank form
Goalscorer and Rank:
Searching for all matches on a date:
List of Match IDs for Date:
Search for Any Events based on Match ID
- We can search for any event in PA for a player
- "goal" | "free kick" | "shot on target" | "own goal"
One of the issues faced with this endpoint os the structure of the XML data: depending on whether a player has been substituted, scored 1 or more goals will place data in an array or an object. the logic for this takes this into account to 'clean the data'
