Github README documentation Error for Serving the Site Locally

[jonmchan]

https://github.com/grpc/grpc.io#serve-the-site-locally states npm run serve should start a server on port localhost:8888. However, the current server starts on http://localhost:1313/. When I tried to visit http://localhost:8888, there is no server listening on that port.

[chalin]

We have the same setup for several projects and local sites get served at port 8888. For example:

$ npm run serve                                                                                    
...
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

   ┌─────────────────────────────────────────────────┐
   │                                                 │
   │   ◈ Server now ready on http://localhost:8888   │
   │                                                 │
   └─────────────────────────────────────────────────┘

Note the message in the box: Server now ready on http://localhost:8888.

Maybe there's something wrong with your local setup.

[jonmchan]

I did a clean install and running from the main branch. Is there any additional setup besides npm install and npm run serve?

Jonathans-TI-MacBook-Pro:tmp jonathan$ git clone https://github.com/grpc/grpc.io.git
Cloning into 'grpc.io'...
remote: Enumerating objects: 6428, done.
remote: Counting objects: 100% (483/483), done.
remote: Compressing objects: 100% (327/327), done.
remote: Total 6428 (delta 247), reused 216 (delta 105), pack-reused 5945
Receiving objects: 100% (6428/6428), 22.67 MiB | 636.00 KiB/s, done.
Resolving deltas: 100% (3919/3919), done.
Jonathans-TI-MacBook-Pro:tmp jonathan$ cd grpc.io/
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ git branch
* main
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ npm install
...

Jonathans-TI-MacBook-Pro:grpc.io jonathan$ npm run serve

> preserve
> npm run _prebuild


> _prebuild
> npm run get:submodule


> get:submodule
> npm run _get:${GET:-submodule}


> _get:submodule
> set -x && git submodule update --init --recursive ${DEPTH:- --depth 1}

+ git submodule update --init --recursive --depth 1

> serve
> npm run _serve


> _serve
> netlify dev -c "npm run _serve:hugo"

◈ Netlify Dev ◈
◈ Ignored general context env var: LANG (defined in process)
◈ Starting Netlify Dev with Hugo

> _serve:hugo
> hugo serve -DFE --minify

Start building sites … 
hugo v0.93.2-643B5AE9+extended darwin/amd64 BuildDate=2022-03-04T12:21:49Z VendorInfo=gohugoio
WARN 2022/03/05 14:15:04 The google_news internal template will be removed in a future release. Please remove calls to this template. See https://github.com/gohugoio/hugo/issues/9172 for additional information.
WARN 2022/03/05 14:15:05 .Path when the page is backed by a file is deprecated and will be removed in a future release. We plan to use Path for a canonical source path and you probably want to check the source is a file. To get the current behaviour, you can use a construct similar to the one below:

  {{ $path := "" }}
  {{ with .File }}
	{{ $path = .Path }}
  {{ else }}
	{{ $path = .Path }}
  {{ end }}


Re-run Hugo with the flag --panicOnWarning to get a better error message.

                   | EN   
-------------------+------
  Pages            | 143  
  Paginator pages  |   4  
  Non-page files   |   0  
  Static files     | 177  
  Processed images |   0  
  Aliases          |   1  
  Sitemaps         |   1  
  Cleaned          |   0  

Built in 1283 ms
Watching for changes in /tmp/grpc.io/{archetypes,assets,content,data,layouts,package.json,static,themes}
Watching for config changes in /tmp/grpc.io/config.yaml, /tmp/grpc.io/themes/docsy/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Only 1313 is listening:

Jonathans-TI-MacBook-Pro:~ jonathan$ sudo lsof -PiTCP -sTCP:LISTEN|egrep '1313|8888'
hugo      23644 jonathan 7871u  IPv4 0x187898ad287cc139      0t0  TCP localhost:1313 (LISTEN)

My setup:

Jonathans-TI-MacBook-Pro:grpc.io jonathan$ sw_vers 
ProductName:	Mac OS X
ProductVersion:	10.15.7
BuildVersion:	19H1615
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ npm --version
8.3.1
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ node --version
v17.4.0

[jonmchan]

It would appear the netlify proxy is not starting? I believe it should be running on both 1313 and 8888 for a proper setup? Can someone please confirm. Thank you.

[chalin]

Which version of node are you using? (And which version of macOS?)

[jonmchan]

My setup:

Jonathans-TI-MacBook-Pro:grpc.io jonathan$ sw_vers 
ProductName:	Mac OS X
ProductVersion:	10.15.7
BuildVersion:	19H1615
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ npm --version
8.3.1
Jonathans-TI-MacBook-Pro:grpc.io jonathan$ node --version
v17.4.0

[chalin]

Could you try again using the latest LTS version of Node, that is, version 16? That's the version we officially use.

[chalin]

It seems that the Netlify CLI doesn't currently work under Node v17. For details, see netlify/cli#3617 -- in particular netlify/cli#3617 (comment).

I'm going to close this issue for now. If you're still having problems under Node v16, feel free to reopen the issue and/or add a comment here.

[jonmchan]

@chalin thanks for your suggestions and help. Confirmed, netlify works when using the proper node version.

Logs:

$ node --version
v16.14.0

$ npm run serve
...
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

   ┌─────────────────────────────────────────────────┐
   │                                                 │
   │   ◈ Server now ready on http://localhost:8888   │
   │                                                 │
   └─────────────────────────────────────────────────┘

I can confirm that both localhost:1313 and localhost:8888 are now properly serving locally when starting the server.

[chalin]

Great, thanks for confirming!