Skip to content

Commit aa8988d

Browse files
committed
Add more detail to the contribution docs
1 parent 6b4e99f commit aa8988d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,13 @@ To get started:
3232
* `npm install`
3333
* `npm start`
3434
* A [Mockttp](https://npmjs.com/package/mockttp) standalone server will start on port 45456, and a graphql management server on 45457.
35-
* Either make requests to the servers by hand, or start a UI using it by:
35+
* Either make requests to the servers by hand, use the production UI by opening `https://app.httptoolkit.tech` in a Chromium-based browser, or start and use a local UI by:
3636
* Setting up the web UI locally (see [httptoolkit/httptoolkit-ui#contributing](https://github.com/httptoolkit/httptoolkit-ui#contributing)).
3737
* Running `npm run start:web` there to start the UI without its own server.
38+
* Opening `http://local.httptoolkit.tech:8080` in a Chromium-based browser
3839

3940
A few tips:
4041

4142
* Running the server with `ENABLE_PLAYGROUND` set to `true` at the top of [`src/api-server.ts`](src/api-server.ts#L16) will give you a GraphQL playground on http://localhost:45457/.
4243
* New interceptors need to be added to `src/interceptors/index.ts`. They will also need to be added to [the UI](https://github.com/httptoolkit/httptoolkit-ui).
43-
* The tests assume that the required applications are installed to run every interceptor. See [.travis.yml](.travis.yml) for an example of how to set this up.
44+
* The tests assume that the required applications are installed to run every interceptor. See [.travis.yml](.travis.yml) for an example of how to set this up.

0 commit comments

Comments
 (0)