Skip to content

Commit 3931f92

Browse files
mantisVesaJuvonen
authored andcommitted
Improve documentation around listening ports (SharePoint#4427)
The documentation around listening ports is incorrect. gulp serve sets up a node server to listen on port 4321 and then the workbench on ports 5432. This is not included in the docs. In addition, where port 5432 is the default port for postgres, and could be used by other applications. There is no indicator that the port is not available when starting the application. The existing note only refers to certificate issues in the browser. Modern browsers show the connection failure as a possible TLS issue, therefore, enhance the documentation by suggesting that the user may also wants to confirm that the port is available. Whilst i'd personally use tcpview from sysinternals, I've suggested an approach using built in windows 10 functionality.
1 parent 40bfcdc commit 3931f92

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/spfx/web-parts/get-started/build-a-hello-world-web-part.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,11 @@ Now that we have installed the developer certificate, enter the following comman
101101
gulp serve
102102
```
103103

104-
This command executes a series of gulp tasks to create a local, node-based HTTPS server on `localhost:4321` and launches your default browser to preview web parts from your local dev environment.
104+
This command executes a series of gulp tasks to create a local, node-based HTTPS server on `localhost:4321` and `localhost:5432`. The workbench is then launched in your default browser to preview web parts from your local dev environment.
105105

106106
> [!NOTE]
107107
> If you are seeing issues with the certificate in browser, please see details on installing a developer certificate from the [Set up your development environment](../../set-up-your-development-environment.md) article.
108+
> If you are still seeing issues, please check nothing else is listening on the port numbers, by using resmon.exe, the network tab and looking at Listening Ports.
108109

109110
![Gulp serve web part project](../../../images/helloworld-wp-gulp-serve.png)
110111

0 commit comments

Comments
 (0)