]> git.openstreetmap.org Git - nominatim-ui.git/blob - CONTRIBUTE.md
Merge pull request #35 from mtmail/checking-isaddress
[nominatim-ui.git] / CONTRIBUTE.md
1 # Developing Nominatim-UI
2
3 ## Background
4
5 The user interface used to be included in the geocoder. Thus the
6 first version avoid being a redesign and still uses some of the
7 same configuration values. For simplicity it's not a single
8 page application (SPA) written in a framework though it could
9 be in the future if complexity grows.
10
11 Uses [jQuery](https://jquery.com/) for browser DOM interaction,
12 [handlebar](http://handlebarsjs.com/) templates to build pages,
13 [leaflet](https://leafletjs.com/) for map interaction,
14 [bootstrap](https://getbootstrap.com/) for layout styling.
15
16
17 ## Building the frontend
18
19 * Install dependencies
20
21    ```
22    yarn install
23    ```
24
25 * After you change files in `src` directory run
26
27    ```
28    yarn build
29    ```
30
31 * Start a webserver on port 8000 to preview changes
32
33    ```
34    yarn start
35    ```
36
37 * Run code style check
38
39    ```
40    yarn lint
41    ```
42
43 ## Prepare a release
44
45 1. Update version number in `package.json` file
46
47 2. Update `CHANGES.md` file
48
49 3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
50
51 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
52
53 5. Upload release