Skip to content

ideal-postcodes/postcodes.io

master
Switch branches/tags
Code

Latest commit

Bumps [nodemon](https://github.com/remy/nodemon) from 2.0.15 to 2.0.19.
- [Release notes](https://github.com/remy/nodemon/releases)
- [Commits](remy/nodemon@v2.0.15...v2.0.19)

---
updated-dependencies:
- dependency-name: nodemon
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
186450c

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Postcodes.io

UK postcode & geolocation API, serving up open data

CI codecov Dependency Status DOI

Query for UK postcodes and geolocations over HTTP.

Postcodes.io regularly ingests and serves the ONS Postcode Directory and Ordnance Survey Open Names datasets.

Features

  • Postcode lookup, resolve administrative and location data for postcodes and outward codes
  • Postcode search & autocomplete
  • Reverse geocode postcodes
  • Nearest postcode search
  • Terminated postcode search
  • Outward code lookup
  • Bulk postcode lookup and reverse geocoding

Usage

Quick Start

Start querying UK postcode data immediately on your local machine with Docker

docker-compose up

Docker Compose Demo

Testing

# Run entire test suite
make test

# Launch test application container and services, and run tests from container
make test-up
make test-shell
$api-container> npm test

License

MIT