NYC GeoSearch API Documentation
NYC GeoSearch is an API that transforms input text — such as an address, or the name of a place — to a location in New York City using authoritative NYC address data from the Property Address Directory (PAD) via Pelias (a modular, open-source geocoder built on top of ElasticSearch for fast geocoding). NYC GeoSearch powers the autocomplete/typeahead search results in web apps such as ZoLa and Population Fact Finder.
How you can help
In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute.
- Comment on or clarify [issues](link to issues)
- Report [bugs](link to bugs)
- Suggest new features
- Write or edit documentation
- Write code (no patch is too small)
- Fix typos
- Add comments
- Clean up code
- Add new features
You will need the following things properly installed on your computer.
- Clone this repo
git clone firstname.lastname@example.org:NYCPlanning/labs-nyc-geosearch-docs.git
- Navigate to the project directory
yarnto install dependencies
gatsby develop— Gatsby will start a hot-reloading development environment accessible at
gatsby serve— Gatsby starts a local HTML server for testing your built site.
- NYC GeoSearch ([insert API URL here])
This project can be deployed on any static web server.
- Deploy via Dokku using
npm run deploy