Merge remote-tracking branch 'upstream/master'

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 0f7abc18d0bdbef28319b9b3bd704f42c46a9b6f..7ef727d4c31156f26520a1ef0cbe6224682c81b5 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -1,14 +1,18 @@
 # 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
 
+Uses [Svelte](https://svelte.dev/) framework,
+[Leaflet](https://leafletjs.com/) for map interaction,
+[Bootstrap](https://getbootstrap.com/) for layout styling.
+
 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.
+first version avoided being a redesign and still uses some of the
+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,
-[bootstrap](https://getbootstrap.com/) for layout styling.
 
 
 ## Building the frontend
@@ -24,8 +28,25 @@ Uses [svelte](https://svelte.dev/) framework,
    ```
    yarn dev
    ```
-   which will start a webserver on port 5000 and auto-reloads
-   whenever you edit files.
+   which will start a webserver on port 9880 and auto-reloads
+   whenever you edit files. Configuration in `rollup.config.js`.
+
+## Testing
+
+The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Puppeteer](https://pptr.dev/) to control a Google Chrome headless browser and evaluate with [Assert](https://nodejs.org/api/assert.html).
+
+
+* Run integration test suite (configuration in `.mocharc.js`)
+
+   ```
+   yarn test
+   ```
+
+* Run syntax linter (configuration in `.eslint.js`)
+
+   ```
+   yarn lint
+   ```
 
 
 ## Prepare a release
@@ -38,4 +59,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.