X-Git-Url: https://git.openstreetmap.org./nominatim-ui.git/blobdiff_plain/4344b0ba745cd79ee77dc3698d5237858d97632f..3e213d26b00e549a6c583bf5066e1985aa3e0996:/README.md diff --git a/README.md b/README.md index bd1748b..fa4f021 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,39 @@ # Nominatim-UI +![GitHub release (latest by date)](https://img.shields.io/github/v/release/osm-search/nominatim-ui) + Debugging user interface for [Nominatim](https://nominatim.org/) ([source](https://github.com/osm-search/Nominatim/)) geocoder. -The frontend runs standalone as website and will requests data -from a separate Nominatim API (either on the same server or -remote). -For technical details see [CONTRIBUTING.md]() file. +The frontend runs standalone as website and will request data +from a separate Nominatim API running on http://localhost:80/nominatim/ (configurable, see below). + +Download a stable release from [https://github.com/osm-search/nominatim-ui/releases](https://github.com/osm-search/nominatim-ui/releases). +For technical background, how to develop and create a release see [CONTRIBUTE.md](CONTRIBUTE.md) file at [https://github.com/osm-search/nominatim-ui/](https://github.com/osm-search/nominatim-ui). ![Screenshot](screenshot.png) ## Starting the frontend -* You can open the `dist` directory in your browser. +You can either + +* open the `dist` directory in your browser. -* If you have python installed (part of the Nominatim server installation): +* if you have Python installed (part of the Nominatim API server installation): 1. `cd dist` 2. start webserver `python3 -m http.server 8765` 3. open [http://localhost:8765/]() in your browser -* Start a webserver using ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)) or configure Apache, nginx or other webservers to serve the `dist` directory. +* start a webserver using ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)) or configure Apache, nginx or other webservers to serve the `dist` directory. ## Configuration -Create a `dist/config.js` file, you can use `dist/config.example.js` as basis (just copy it). All settings are optional. Usually you want to set the `Nominatim_API_Endpoint` value at least. - -Defaults: - -| setting | default | -|---|---| -| `Nominatim_API_Endpoint` | http://localhost/nominatim/ (port 80) | -| `Images_Base_Url` | images in [mapicons]() | -| `Search_AreaPolygons` | yes, print boundaries of search results on map | -| `Reverse_Default_Search_Zoom` | 18 (house-number level) | -| `Map_Default_Lat`, `Map_Default_Lon`, `Map_Default_Zoom` | display whole world | -| `Map_Tile_URL` | load from openstreetmap.org | -| `Map_Tile_Attribution` | [OpenStreetMap](https://openstreetmap.org/copyright) obviously | +You can customize your installation by creating and editing `dist/theme/config.theme.js` which allows you to override the default values provided by `dist/config.default.js`. See the `config.theme.js.example` in the same directory for examples. +The `dist/theme/` directory also contains files make it easy to set a different +logo image, colors, welcome and help text. ## License