X-Git-Url: https://git.openstreetmap.org/nominatim-ui.git/blobdiff_plain/c9687b102bb6f544a034dc4d508bf0ae4a5fc221..23d68e84c00ba741a29e4e088ef12aa7b23e045c:/CONTRIBUTE.md diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 0f7abc1..66251be 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,10 +1,13 @@ # Developing Nominatim-UI +[![Continuous Integration](https://github.com/osm-search/nominatim-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/osm-search/nominatim-ui/actions/workflows/ci.yml) + ## Background 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. +same configuration values. Version 2 was a full refactor using +Svelte. Version 3 added theme and easier configuration. Uses [svelte](https://svelte.dev/) framework, [leaflet](https://leafletjs.com/) for map interaction, @@ -24,9 +27,16 @@ Uses [svelte](https://svelte.dev/) framework, ``` yarn dev ``` - which will start a webserver on port 5000 and auto-reloads + which will start a webserver on port 9880 and auto-reloads whenever you edit files. +## Testing + +* Run syntax linter + + ``` + yarn lint + ``` ## Prepare a release @@ -38,4 +48,5 @@ Uses [svelte](https://svelte.dev/) framework, 4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags` -5. Upload release \ No newline at end of file +5. Create release on https://github.com/osm-search/nominatim-ui/releases + This (a triggered Github Action) will run `yarn build` and add the `dist/build/bundle.*` files.