{"id":21343737,"url":"https://github.com/catalystcode/featureservice","last_synced_at":"2025-06-10T12:38:48.164Z","repository":{"id":73517007,"uuid":"96112650","full_name":"CatalystCode/featureService","owner":"CatalystCode","description":"Open Street Maps geographical features as a service","archived":false,"fork":false,"pushed_at":"2018-08-24T20:57:44.000Z","size":201,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-01-22T15:48:00.573Z","etag":null,"topics":["nodejs","osm","postgres"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CatalystCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-03T13:15:48.000Z","updated_at":"2018-08-24T15:38:51.000Z","dependencies_parsed_at":"2023-06-01T06:45:22.786Z","dependency_job_id":null,"html_url":"https://github.com/CatalystCode/featureService","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatalystCode%2FfeatureService","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatalystCode%2FfeatureService/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatalystCode%2FfeatureService/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatalystCode%2FfeatureService/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CatalystCode","download_url":"https://codeload.github.com/CatalystCode/featureService/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243818199,"owners_count":20352629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","osm","postgres"],"created_at":"2024-11-22T01:15:04.139Z","updated_at":"2025-03-16T03:14:26.047Z","avatar_url":"https://github.com/CatalystCode.png","language":"JavaScript","readme":"# featureService #\n\n[![Travis CI status](https://api.travis-ci.org/CatalystCode/featureService.svg?branch=master)](https://travis-ci.org/CatalystCode/featureService)\n[![Docker Pulls](https://img.shields.io/docker/pulls/cwolff/featureservice.svg)](https://hub.docker.com/r/cwolff/featureservice/)\n\n## What's this? ##\n\nThe featureService is a simple JSON REST API that enables you to work with the\n[OpenStreetMap](https://www.openstreetmap.org/) data-set.\n\nUsing the featureService you can, for example, discover all the locations or\npoints of interest in a particular area or look up properties of locations such\nas their bounding box, centroid or name.\n\n## Setup ##\n\n### System dependencies ###\n\nIn order to run this project on your machine, you will need to install the\nfollowing system-level dependencies:\n\n- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)\n- [Docker](https://docs.docker.com/docker-for-windows/)\n\n### Azure resources ###\n\nYou will need to set up an instance of [Azure Databases for PostgreSQL](https://azure.microsoft.com/en-us/services/postgresql/) for the featureService.\n\nYou can run the following snippet in a Bash shell (such as the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10))\nto set up a new instance of Azure Databases for PostgreSQL using the Azure CLI:\n\n```sh\ndbname=\"----CHANGEME----\"             # e.g. myfeaturesservicedb\ndbuser=\"----CHANGEME----\"             # e.g. admin\ndbpassword=\"----CHANGEME----\"         # e.g. featureService1!Rocks\ndbsku=\"----CHANGEME----\"              # e.g. GP_Gen4_2\nresource_group=\"----CHANGEME----\"     # e.g. myfeaturesserviceresourcegroup\nresource_location=\"----CHANGEME----\"  # e.g. eastus\n\naz group create \\\n  --name=\"${resource_group}\" \\\n  --location=\"${resource_location}\"\n\naz postgres server create \\\n  --name=\"${dbname}\" \\\n  --admin-user=\"${dbuser}\" \\\n  --admin-password=\"${dbpassword}\" \\\n  --resource-group=\"${resource_group}\" \\\n  --location=\"${resource_location}\" \\\n  --sku-name=\"${dbsku}\"\n```\n\nNext, enable clients to connect to the database. You can either white-list particular\nIPs or a range of IPs:\n\n```sh\naz postgres server firewall-rule create \\\n  --server-name=\"${dbname}\" \\\n  --resource-group=\"${resource_group}\" \\\n  --start-ip-address=\"0.0.0.0\" \\\n  --end-ip-address=\"255.255.255.255\" \\\n  --name=\"AllowAll\"\n```\n\n### Running the application ###\n\nOnce the system dependencies are installed and your Postgres database has been\ncreated, you can run the project via Docker:\n\n```sh\ndocker build -t featureservice .\n\ndocker run \\\n  -p 3035:80 \\\n  -e FEATURES_DB_USER=\"${dbuser}@${dbname}\" \\\n  -e FEATURES_DB_PASSWORD=\"${dbpassword}\" \\\n  -e FEATURES_DB_HOST=\"${dbname}.postgres.database.azure.com\" \\\n  -t featureservice\n```\n\nThe first time that you run this command, it will take about 90 minutes while\nyour Postgres on Azure instance is getting populated with over 2GB of global\ngeo-spatial features and appropriate indices are being built. On subsequent\nruns, the start should be instantaneous.\n\n### Using the application ##\n\nAfter starting the service, you will be able to call the featureService, for\nexample via the following requests:\n\n- http://localhost:3035/features/name/bogota\n- http://localhost:3035/features/point/18.678/15.123\n- http://localhost:3035/features/bbox/12.3/22.3/12.4/22.4\n- http://localhost:3035/features/id/wof-85975935,wof-404477281?include=bbox,centroid\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalystcode%2Ffeatureservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatalystcode%2Ffeatureservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalystcode%2Ffeatureservice/lists"}