Skip to content

Commit 50e228c

Browse files
committed
DOC: Installation and test procedure.
1 parent 34918d9 commit 50e228c

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,35 @@
11
# GeoXEne – Geocoding through transmission or emulation
22

3-
1. Start the service:
43

5-
docker run -d -p 3000:3000 benel/geoxene
4+
## How to test the development version
5+
6+
### Requirements
7+
8+
- node and npm
9+
- A [Google API key](https://console.cloud.google.com/) authorized for "Geocoding API".
10+
11+
### Installation
12+
13+
npm install
14+
15+
### Start
16+
17+
npm start
18+
19+
### Test
20+
21+
#### Geocode an address known by Google Maps
22+
23+
Open http://localhost:3000/json?address=Kerameikos&key={KEY}
24+
25+
The result is transmitted from https://maps.googleapis.com/maps/api/geocode/json?address=Kerameikos&key={KEY}
26+
27+
28+
#### Geocode a custom address (unknown to Google Maps)
29+
30+
Open http://localhost:3000/json?address=Tombe%202,%20N%C3%A9cropole%20au%20Nord%20de%20l%27Eridanos,%20Kerameikos&key={KEY}
31+
32+
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}
33+
34+
Please note that all the custom addresses can be seen on a map at <http://localhost:3000/>.
635

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

0 commit comments

Comments
 (0)