README.md

   1 # Nominatim-UI
   2
   3 Debugging user interface for [Nominatim](https://nominatim.org/)
   4 ([source](https://github.com/osm-search/Nominatim/)) geocoder.
   5 The frontend runs standalone as website and will requests data
   6 from a separate Nominatim API (either on the same server or
   7 remote).
   8
   9 For technical details see [CONTRIBUTE.md](CONTRIBUTE.md) file.
  10
  11 ![Screenshot](screenshot.png)
  12
  13 ## Starting the frontend
  14
  15 * You can open the `dist` directory in your browser.
  16
  17 * If you have python installed (part of the Nominatim server installation):
  18
  19    1. `cd dist`
  20    2. start webserver `python3 -m http.server 8765`
  21    3. open http://localhost:8765/ in your browser
  22
  23 * 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.
  24
  25
  26 ## Configuration
  27
  28 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.
  29
  30 Defaults:
  31
  32 | setting | default |
  33 |---|---|
  34 | `Nominatim_API_Endpoint` | http://localhost/nominatim/ (port 80) |
  35 | `Images_Base_Url` | images in [mapicons](dist/mapicons) |
  36 | `Search_AreaPolygons` | yes, print boundaries of search results on map |
  37 | `Reverse_Default_Search_Zoom` | 18 (house-number level) |
  38 | `Map_Default_Lat`, `Map_Default_Lon`, `Map_Default_Zoom` | display whole world |
  39 | `Map_Tile_URL` | load from openstreetmap.org |
  40 | `Map_Tile_Attribution` | [OpenStreetMap](https://openstreetmap.org/copyright) obviously |
  41
  42
  43 ## Theming
  44
  45 You can customize parts of the website by overwriting files in `dist/theme/`
  46
  47    * Set a `Page_Title` in the configuration
  48    * Logo
  49    * Content of Welcome and About&Help page
  50    * Additional CSS styling
  51
  52 ## License
  53
  54 The source code is available under a [GPLv2 license](LICENSE).