Our aim was to build a simple web app (ideally just a single page). It must query at least two APIs and use the results to update the DOM.
A young family expecting a baby is looking for a house to buy in a safe area. Leonie 👀 You were our inspiration! ❤️
They have an idea about where they want to live but would like to know local crime rates and house prices.
After major issues with the Zoopla API we had to adjust the user story slightly:
A young family expecting a baby is looking for a place in a safe area, and would like to know about the number of recent crimes by category.
- Use 20/20/20 - if a pair has not found an answer after 20 min we can open the problem up to the team and do a mob
- Esure everyone pairs up with everyone at least once
- Have meetings after every milestone
- Conglomerate all tasks in our HackMD
- Create a sketch of the infrastructure
- We agreed that working on the user journey is the most central piece of the project
- Transfer Requirements into Issues
- We agreed to follow BEM for classs naming (usefull link here https://css-tricks.com/bem-101/)
- We will create our app with the mobile first approach in mind
- We will create a new branch for every new feature / piece of code
- We will not use capitals in branch names and include either "feature/" or "fix/"
- Ensure common understanding of the "Things to check before you start" section - eg. CORS, oAuth, ENV2
- Brainstorm API's and how they could work together / go through everyones Idea
- Agree on final userstory (define MVP)
- Outline/sketch app architecture (define MVP)
- Create basic mock up design (define MVP)
- Create list of requirements
- Transform requirements into github issues (more granular if needed)
A user inputs their postcode into an input field. This must be a valid postcode which is checked against the governement's regex/postcode validator. Once the postcode passes the validation check, an API call is triggered to the Postcode & Geolocation API. This then returns the longitude and latitude data back.
If the call has been successfull, we call the POLICE! 😄
The result of the Geolocation API triggers a callback call to the Police UK API with the exact coordinates (as the Police API does not support postcodes), which in itself returns data about reported crimes for a specific month of the year. Through a number of tested functions, we extract the crimes by category and display their count to the user to help them make an informed decision before bying a house in that area.
POLICE UK - https://data.police.uk/docs/
Postcode & Geolocation API for the UK - http://postcodes.io/
{
"status": 200,
"result": {
"postcode": "SW1A 1AA",
"quality": 1,
"eastings": 529090,
"northings": 179645,
"country": "England",
"nhs_ha": "London",
"longitude": -0.141588,
"latitude": 51.501009,
.....................
}Zoopla appears to have been abandoned, while leaving all of its documentation and endpoints active.
Geocode was offering a free trial but the pitifall is that it asks for your credit card and can actually become expensive.
ZOOPLA - https://developer.zoopla.co.uk/docs/
GEOCODE - https://geocode.xyz/api