Merge pull request #10 from mtmail/skip-empty-values

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 0f1d3e3f5a7e990fcb2a57c1c74db027f3acf75f..2acb5ba8d10cbfac38556e5bd52964722a538551 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,55 @@
 # Nominatim-UI
 
 # Nominatim-UI
 

-Frontend for [Nominatim](https://nominatim.org/) ([source](https://github.com/openstreetmap/Nominatim/)) geocoder.
+Debugging user interface for [Nominatim](https://nominatim.org/)
+([source](https://github.com/openstreetmap/Nominatim/)) geocoder.
+The frontend runs standalone as website and will requests data
+from a separate Nominatim API (either on the same server or
+remote).

 
 

-Preview version. See TODO file.
+Uses [jQuery](https://jquery.com/) for browser DOM interaction,
+[handlebar](http://handlebarsjs.com/) templates to build pages,
+[leaflet](https://leafletjs.com/) for map interaction,
+[bootstrap](https://getbootstrap.com/) for layout styling.

 
 

-http://handlebarsjs.com/

 
 

+## Background

 
 

-## Installation
+The user interface used to be included in the geocoder. Thus the
+first version avoid being a redesign and still uses some of the
+same configuration values. For simplicity it's not a single
+page application (SPA) written in a framework though it could
+be if complexity grows.

 
 

-1. run build

 
 

-```
-./build.sh
-```
+## Starting the frontend

 
 

-2. start any webserver to serve static files, e.g.
+You can open the `dist` directory in your browser.

 
 

-```
-php -S localhost:8000 -t dist
-```
+You can run `yarn start` to start a simple HTTP webserver and open
+[http://localhost:8000/]() in your browser.
+
+Or start another webserver ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)).
+
+
+## Configuration
+
+In `dist/config.js` you will find configuration options. The first
+you want to doublecheck is the `Nominatim_API_Endpoint` URL.
+
+
+## Building the frontend
+
+* Install dependencies
+
+   ```
+   yarn install
+   ```
+
+* After you change files in `src` directory
+
+   ```
+   yarn build
+   ```

 
 ## License
 
 
 ## License