README.md

Postcodes.io

Query for UK postcodes and geolocations over HTTP. Postcodes.io uses the Office for National Statistics Postcode Directory.

Documentation can be found at postcodes.io

Requirements

Please make sure you have the following available:

• Node.js v8.9 (Instructions)
• PostgreSQL (10 or greater)
• PostGIS extension (Instructions)

Run with Docker

docker-compose up

Self Hosting

Instructions for installing and hosting postcodes.io yourself can be found at postcodes.io/docs. Methods include:

• Install as Docker containers
• Install on host with Node.js and Postgresql
• Download and import the raw dataset to Postgresql

Testing

npm run setup_test_db # create test database

npm test

External Libraries

A list of external libraries can be found on the about page

License

MIT