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 run `yarn start` to start a simple HTTP webserver and open
  29 [http://localhost:8000/]() in your browser.
  30
  31 Or start another webserver ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)).
  32
  33
  34 ## Configuration
  35
  36 In `dist/config.js` you will find configuration options. The first
  37 you want to doublecheck is the `Nominatim_API_Endpoint` URL.
  38
  39
  40 ## Building the frontend
  41
  42 * Install dependencies
  43
  44    ```
  45    yarn install
  46    ```
  47
  48 * After you change files in `src` directory
  49
  50    ```
  51    yarn build
  52    ```
  53
  54 ## License
  55
  56 The source code is available under a GPLv2 license.