Cranie/postcodes.io
1
0
Fork 0
mirror of https://github.com/0507spc/postcodes.io synced 2026-02-15 23:04:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
1,856 commits 1 branch 0 tags 20 MiB
Find a file
Exact
semantic-release-bot 656f16bb2c chore(release): 16.0.1 [skip ci] 
## [16.0.1](https://github.com/ideal-postcodes/postcodes.io/compare/16.0.0...16.0.1) (2024-05-31)

### Bug Fixes

* **Support Tables:** Rebuild constituency table ([ebcfc19](ebcfc1990c))
2024-05-31 13:02:18 +00:00
.github Bump to 20 2024-05-28 22:45:02 +02:00
bin Environment variable mismatch 2022-08-25 11:02:09 +02:00
data Add May 2024 PCON patch 2024-05-28 22:45:02 +02:00
docker Fix CI error 2024-05-28 22:45:02 +02:00
openapi Delete openapi/components/README.md 2024-04-26 14:41:31 +02:00
public reverse geocoding 2024-04-26 14:41:31 +02:00
src Typo 2024-05-28 22:45:02 +02:00
test fix(Constituencies): Put 2024 Cons in separate field 2024-03-06 10:34:43 +01:00
views feat(ONSPD May): Update for May 2024 2024-05-28 22:45:02 +02:00
.dockerignore Avoid putting git and node_modules in images 2018-10-29 14:55:48 +01:00
.env Load in .env configuration 2019-03-23 12:07:55 +01:00
.eslintignore feat(Postcodes.io): Port to Typescript 2020-12-09 15:26:53 +01:00
.eslintrc.js feat(Postcodes.io): Port to Typescript 2020-12-09 15:26:53 +01:00
.gitignore Ignore hidden csvs 2024-01-31 13:53:54 +01:00
.redocly.yaml Add redocly make first build 2024-04-26 14:41:31 +02:00
CHANGELOG.md chore(release): 16.0.1 [skip ci] 2024-05-31 13:02:18 +00:00
docker-compose.yml docs(Docker Compose): Add restart policy 2020-12-09 15:26:53 +01:00
Dockerfile fix(Node): Bump to v20 2024-01-31 14:08:27 +01:00
Dockerfile.pg feat(Postgres): Upgrade to Postgresql 16 2024-05-28 22:45:02 +02:00
latest fix(Support Tables): Rebuild constituency table 2024-05-31 15:01:33 +02:00
LICENSE Create LICENSE 2017-09-29 10:34:31 +01:00
Makefile feat(Postcodes.io): Port to Typescript 2020-12-09 15:26:53 +01:00
package-lock.json update package.json 2024-04-26 14:41:31 +02:00
package.json update package.json 2024-04-26 14:41:31 +02:00
README.md Update README.md 2024-05-29 15:25:16 +02:00
tsconfig.json feat(Postcodes.io): Port to Typescript 2020-12-09 15:26:53 +01:00
tslint.json feat(Postcodes.io): Port to Typescript 2020-12-09 15:26:53 +01:00

README.md

Postcodes.io

UK postcode & geolocation API, serving up open data

CI 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