Geolocations with FastAPI & Mongo. United Kingdom is currently the only region supported but other regions will be supported in the future.
- Run mongodb
- Clone & cd into the root folder of this repo
- Setup a mongo database as a container - see docker-compose example
- Make sure you have
mongoimport(For Linux See Installing the Database Tools on Linux) cmd installed & run the following make task:
# This will create a `towns` table in your db from the `towns.json` dump
make mongo-import-towns
# OR run the following cmd:
mongoimport -d bn_database -c towns --file ./towns.json --authenticationDatabase admin --username <YOUR_USERNAME> --password <YOUR_PASSWORD> --host localhost --port 27017- Run the latest version of geolocations-api
docker run bandnoticeboard/geolocations-apiOr using docker-compose run mongodb & geolocation-api containers. See docker-compose example
Currently, the api returns 5 entrees per query
Use the name query param to fetch the first 5 similar results:
curl http://localhost:6000/towns?name=colWill return
[
{
longitude: -6.32584,
latitude: 58.2798,
type: "Other",
country: "Scotland",
county: "Na h-Eileanan an Iar",
reference: "COL",
town: "Col",
id: "56c4b2f97c82251d12547b6b"
},
... # plus 4 other entrees
]See docker-compose.example.yml
version: "3"
services:
geolocations_api:
# Uncomment if you are on Linux
# extra_hosts:
# - "host.docker.internal:host-gateway"
image: "bandnoticeboard/geolocations-api:latest"
ports:
- "8000:8000"
environment:
API_DB_NAME: towns_db
API_DB_USERNAME: admin
API_DB_PASSWORD: admin
API_DB_HOST: host.docker.internal
API_DB_PORT: 27017
SERVER_PORT: 8000
SERVER_HOST: 0.0.0.0PR's are welcome for bug fixes or open an issue.
For new features or adding new country geolocation dumps please open an issue first.