Merge remote-tracking branch 'upstream/master'

[nominatim-ui.git] / CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 7ef727d4c31156f26520a1ef0cbe6224682c81b5..c9b7b9cf6fc253f20de56db95d8ce448c4cbdf3c 100644 (file)
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -28,7 +28,7 @@ Svelte. Version 3 added theme and easier configuration.
    ```
    yarn dev
    ```
    ```
    yarn dev
    ```

-   which will start a webserver on port 9880 and auto-reloads
+   which will start a webserver on port 9080 and auto-reloads

    whenever you edit files. Configuration in `rollup.config.js`.
 
 ## Testing
    whenever you edit files. Configuration in `rollup.config.js`.
 
 ## Testing


@@ -40,6 +40,17 @@ The `test/` setup uses [Mocha](https://mochajs.org/) to run tests. Tests use [Pu
 
    ```
    yarn test
 
    ```
    yarn test

+   API_ON_SAME_PORT=1 yarn test
+   ```
+
+   Setting API_ON_SAME_PORT simulates having both the API and UI on the same server
+   port. That's a rare setup but something https://nominatim.openstreetmap.org/ does
+   so worth testing.
+
+   To run a single test file only
+
+   ```
+   yarn run rollup -c && yarn run mocha test/details.js

    ```
 
 * Run syntax linter (configuration in `.eslint.js`)
    ```
 
 * Run syntax linter (configuration in `.eslint.js`)