mirror of
https://github.com/nodejs/node.git
synced 2025-05-21 08:57:07 +00:00
895cc572ac
PR-URL: https://github.com/nodejs/node/pull/43114 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
94 lines
2.1 KiB
Markdown
94 lines
2.1 KiB
Markdown
# Usage and example
|
|
|
|
## Usage
|
|
|
|
<!--introduced_in=v0.10.0-->
|
|
|
|
<!--type=misc-->
|
|
|
|
`node [options] [V8 options] [script.js | -e "script" | - ] [arguments]`
|
|
|
|
Please see the [Command-line options][] document for more information.
|
|
|
|
## Example
|
|
|
|
An example of a [web server][] written with Node.js which responds with
|
|
`'Hello, World!'`:
|
|
|
|
Commands in this document start with `$` or `>` to replicate how they would
|
|
appear in a user's terminal. Do not include the `$` and `>` characters. They are
|
|
there to show the start of each command.
|
|
|
|
Lines that don't start with `$` or `>` character show the output of the previous
|
|
command.
|
|
|
|
First, make sure to have downloaded and installed Node.js. See
|
|
[Installing Node.js via package manager][] for further install information.
|
|
|
|
Now, create an empty project folder called `projects`, then navigate into it.
|
|
|
|
Linux and Mac:
|
|
|
|
```console
|
|
$ mkdir ~/projects
|
|
$ cd ~/projects
|
|
```
|
|
|
|
Windows CMD:
|
|
|
|
```console
|
|
> mkdir %USERPROFILE%\projects
|
|
> cd %USERPROFILE%\projects
|
|
```
|
|
|
|
Windows PowerShell:
|
|
|
|
```console
|
|
> mkdir $env:USERPROFILE\projects
|
|
> cd $env:USERPROFILE\projects
|
|
```
|
|
|
|
Next, create a new source file in the `projects`
|
|
folder and call it `hello-world.js`.
|
|
|
|
Open `hello-world.js` in any preferred text editor and
|
|
paste in the following content:
|
|
|
|
```js
|
|
const http = require('node:http');
|
|
|
|
const hostname = '127.0.0.1';
|
|
const port = 3000;
|
|
|
|
const server = http.createServer((req, res) => {
|
|
res.statusCode = 200;
|
|
res.setHeader('Content-Type', 'text/plain');
|
|
res.end('Hello, World!\n');
|
|
});
|
|
|
|
server.listen(port, hostname, () => {
|
|
console.log(`Server running at http://${hostname}:${port}/`);
|
|
});
|
|
```
|
|
|
|
Save the file, go back to the terminal window, and enter the following command:
|
|
|
|
```console
|
|
$ node hello-world.js
|
|
```
|
|
|
|
Output like this should appear in the terminal:
|
|
|
|
```console
|
|
Server running at http://127.0.0.1:3000/
|
|
```
|
|
|
|
Now, open any preferred web browser and visit `http://127.0.0.1:3000`.
|
|
|
|
If the browser displays the string `Hello, World!`, that indicates
|
|
the server is working.
|
|
|
|
[Command-line options]: cli.md#options
|
|
[Installing Node.js via package manager]: https://nodejs.org/en/download/package-manager/
|
|
[web server]: http.md
|