local-reverse-geocoder

(★ 217)

Local reverse geocoder for Node.js based on GeoNames data

File Explorer

Download Latest Version (.zip)

- - docker.yml
- FUNDING.yml
- - OpenSans-Bold-webfont.eot
  - OpenSans-Bold-webfont.svg
  - OpenSans-Bold-webfont.woff
  - OpenSans-BoldItalic-webfont.eot
  - OpenSans-BoldItalic-webfont.svg
  - OpenSans-BoldItalic-webfont.woff
  - OpenSans-Italic-webfont.eot
  - OpenSans-Italic-webfont.svg
  - OpenSans-Italic-webfont.woff
  - OpenSans-Light-webfont.eot
  - OpenSans-Light-webfont.svg
  - OpenSans-Light-webfont.woff
  - OpenSans-LightItalic-webfont.eot
  - OpenSans-LightItalic-webfont.svg
  - OpenSans-LightItalic-webfont.woff
  - OpenSans-Regular-webfont.eot
  - OpenSans-Regular-webfont.svg
  - OpenSans-Regular-webfont.woff
- - linenumber.js
- - jsdoc-default.css
  - prettify-jsdoc.css
  - prettify-tomorrow.css
- global.html
- index.html
- index.js.html
.gitignore
.jshintrc
.prettierrc
app.js
app.ts
Dockerfile
index.d.ts
index.js
LICENSE
package-lock.json
package.json
postinstall.js
Procfile
README.md

# Installation Guide

1. Get the code

git clone https://github.com/tomayac/local-reverse-geocoder

Downloads the entire project code from GitHub to your computer.

cd local-reverse-geocoder

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

$ docker build -t local-reverse-geocoder .

Builds a runnable image based on the Dockerfile.

$ docker run -it -e PORT=3000 --rm local-reverse-geocoder

Runs the built image as an actual container.

$ docker run -it -e PORT=3000 --rm ghcr.io/tomayac/local-reverse-geocoder

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install local-reverse-geocoder

Downloads and installs the libraries listed in package.json.

$ yarn add local-reverse-geocoder

Type this command into your terminal and run it.

npm install local-reverse-geocoder

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.