README.md

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