]> git.openstreetmap.org Git - nominatim-ui.git/blob - CONTRIBUTE.md
Details search: merge three forms into one (#81)
[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.
8
9 Uses [svelte](https://svelte.dev/) framework,
10 [leaflet](https://leafletjs.com/) for map interaction,
11 [bootstrap](https://getbootstrap.com/) for layout styling.
12
13
14 ## Building the frontend
15
16 * Install dependencies
17
18    ```
19    yarn install
20    ```
21
22 * After you change files in `src` directory run
23
24    ```
25    yarn dev
26    ```
27    which will start a webserver on port 9880 and auto-reloads
28    whenever you edit files.
29
30 ## Testing
31
32 * Run syntax linter
33
34    ```
35    yarn lint
36    ```
37
38 ## Prepare a release
39
40 1. Update version number in `package.json` file
41
42 2. Update `CHANGES.md` file
43
44 3. Run `yarn build` to make sure the `dist/build/` files don't contain lifereload.js
45
46 4. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc
47
48 5. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags`
49
50 6. Upload release