Skip to content

Commit

Permalink
DOC: Installation and test procedure.
Browse files Browse the repository at this point in the history
  • Loading branch information
benel committed May 8, 2022
1 parent 34918d9 commit 50e228c
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@
# GeoXEne – Geocoding through transmission or emulation

1. Start the service:

docker run -d -p 3000:3000 benel/geoxene
## How to test the development version

### Requirements

- node and npm
- A [Google API key](https://console.cloud.google.com/) authorized for "Geocoding API".

### Installation

npm install

### Start

npm start

### Test

#### Geocode an address known by Google Maps

Open http://localhost:3000/json?address=Kerameikos&key={KEY}

The result is transmitted from https://maps.googleapis.com/maps/api/geocode/json?address=Kerameikos&key={KEY}


#### Geocode a custom address (unknown to Google Maps)

Open http://localhost:3000/json?address=Tombe%202,%20N%C3%A9cropole%20au%20Nord%20de%20l%27Eridanos,%20Kerameikos&key={KEY}

The result is different from the approximate result of https://maps.googleapis.com/maps/api/geocode/json?address=Tombe%202,%20N%C3%A9cropole%20au%20Nord%20de%20l%27Eridanos,%20Kerameikos&key={KEY}

Please note that all the custom addresses can be seen on a map at <http://localhost:3000/>.

2. Open <http://localhost:3000/>

0 comments on commit 50e228c

Please sign in to comment.