X-Git-Url: https://git.openstreetmap.org/nominatim-ui.git/blobdiff_plain/6beafb16431a1cf87ad160ab50b07db31971d873..9e8d3367fe08a708b1019ff39ac752e0105be20a:/CONTRIBUTE.md?ds=sidebyside diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index de818e8..e11ae17 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -4,12 +4,9 @@ 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 in the future if complexity grows. +same configuration values. -Uses [jQuery](https://jquery.com/) for browser DOM interaction, -[handlebar](http://handlebarsjs.com/) templates to build pages, +Uses [svelte](https://svelte.dev/) framework, [leaflet](https://leafletjs.com/) for map interaction, [bootstrap](https://getbootstrap.com/) for layout styling. @@ -25,16 +22,14 @@ Uses [jQuery](https://jquery.com/) for browser DOM interaction, * After you change files in `src` directory run ``` - yarn build + yarn dev ``` + which will start a webserver on port 9880 and auto-reloads + whenever you edit files. -* Start a webserver on port 8000 to preview changes +## Testing - ``` - yarn start - ``` - -* Run code style check +* Run syntax linter ``` yarn lint @@ -46,8 +41,10 @@ Uses [jQuery](https://jquery.com/) for browser DOM interaction, 2. Update `CHANGES.md` file -3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc +3. Run `yarn build` to make sure the `dist/build/` files don't contain lifereload.js + +4. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc -4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags` +5. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags` -5. Upload release \ No newline at end of file +6. Upload release \ No newline at end of file