README.md

   1 # Nominatim-UI
   2
   3 Debugging user interface for [Nominatim](https://nominatim.org/)
   4 ([source](https://github.com/openstreetmap/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 Uses [jQuery](https://jquery.com/) for browser DOM interaction,
  10 [handlebar](http://handlebarsjs.com/) templates to build pages,
  11 [leaflet](https://leafletjs.com/) for map interaction,
  12 [bootstrap](https://getbootstrap.com/) for layout styling.
  13
  14
  15 ## Background
  16
  17 The user interface used to be included in the geocoder. Thus the
  18 first version avoid being a redesign and still uses some of the
  19 same configuration values. For simplicity it's not a single
  20 page application (SPA) written in a framework though it could
  21 be if complexity grows.
  22
  23
  24 ## Starting the frontend
  25
  26 You can open the `dist` directory in your browser.
  27
  28 You can start a simple webserver
  29
  30    * PHP
  31
  32    ```
  33    php -S 0.0.0.0:8000 -t dist
  34    ```
  35
  36    * Python
  37
  38    ```
  39    cd dist
  40    python -m SimpleHTTPServer 8000
  41    # python 3
  42    python -m http.server 8000
  43    ```
  44
  45    * NodeJS
  46
  47    ```
  48    # npm install -g light-server
  49    light-server -s dist -p 8000
  50    ```
  51
  52
  53 ## Configuration
  54
  55 In `dist/config.js` you will find configuration options. The first
  56 you want to doublecheck is the `Nominatim_API_Endpoint` URL.
  57
  58
  59 ## Building the frontend
  60
  61 * Install dependencies
  62
  63    ```
  64    yarn install
  65    ```
  66
  67 * After you change files in `src` directory
  68
  69    ```
  70    ./build.sh
  71    ```
  72
  73 ## License
  74
  75 The source code is available under a GPLv2 license.