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
   6 The frontend runs standalone as website and will request data
   7 from a separate Nominatim API running on http://localhost:80/nominatim/ (configurable, see below).
   8
   9 Download a stable release from [https://github.com/osm-search/nominatim-ui/releases]().
  10 For technical background, how to develop and create a release see [CONTRIBUTE.md](CONTRIBUTE.md) file at [https://github.com/osm-search/nominatim-ui/]().
  11
  12 ![Screenshot](screenshot.png)
  13
  14 ## Starting the frontend
  15
  16 You can either
  17
  18 * open the `dist` directory in your browser.
  19
  20 * if you have Python installed (part of the Nominatim API server installation):
  21
  22    1. `cd dist`
  23    2. start webserver `python3 -m http.server 8765`
  24    3. open [http://localhost:8765/]() in your browser
  25
  26 * 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.
  27
  28
  29 ## Configuration
  30
  31 Defaults are set in `dist/config.default.js`.
  32 You can overwrite settings in `dist/config.theme.js`, for example:
  33
  34 ```javascript
  35   Nominatim_Config.Nominatim_API_Endpoint = 'http://my-server:1234/';
  36 ```
  37
  38 The `dist/theme/` directory also contains files make it easy to set a different
  39 logo image, colors, welcome and help text.
  40
  41 ## License
  42
  43 The source code is available under a [GPLv2 license](LICENSE).