Commit a8e42bd6 authored by Aral Balkan's avatar Aral Balkan
Browse files

Improve developer documentation

(Add notes about domain reachability requirements for tests.)
parent 328420e1
......@@ -37,7 +37,13 @@ Generated using [dependency cruiser](https://github.com/sverweij/dependency-crui
Main test tasks use an automatically-managed local Pebble server instance with settings optimised for performance.
__Important:__ Make sure that your system is reachable from your hostname before running the tests.
__Pebble tests__: please add the following line to your hosts file (e.g., `/etc/hosts`) as the Pebble tests require your machine to be reachable using the `localhost` and `pebble` hostnames:
```
127.0.0.1 pebble
```
__Staging tests:__ Make sure that your system is reachable from your hostname before running the tests (e.g., using ngrok)
```sh
npm run test
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment