How to start the server?

I’m pretty sure there must be a server involved somewhere, since it’s a terminal, but the Getting started section at https://xtermjs.org/ doesn’t mention one.

For someone who’s never used node or npm before, it’s not obvious.

I tried downloading the src, naviagating to the demo directory, and trying node start.js, node server.js… and also, npm start, but all crashed.

[jerch]

@Tyriar Linking to the electron demo in node-pty sounds good.

@hyperpallium npm install xterm installs the drilled down package from the npm repo, imho this does not contain the dev parts like the demo in source code repo. To get the demo part as well, run:

#> git clone https://github.com/xtermjs/xterm.js.git
#> cd xterm.js
#> npm install
#> npm start

and point your browser to localhost:3000.

[Tyriar]

We have a warning on the demo HTML page, I think this is enough:

https://github.com/xtermjs/xterm.js/blob/a7b051c52f1cb6bc4c02a1786a9d949bd8d46ad7/demo/index.html#L37

We could also alter the demo to an electron/puppeteer only development path

node-pty has a barebones Electron demo https://github.com/Microsoft/node-pty/tree/master/examples/electron, maybe we should link to that at the bottom of the demo too?