Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit abd98da

Browse files
committed
Update Node.js test projects and READMEs
1 parent b10d3f6 commit abd98da

File tree

21 files changed

+2332
-41
lines changed

21 files changed

+2332
-41
lines changed

containers/javascript-node-8/.devcontainer/devcontainer.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"name": "Node.js 8",
33
"dockerFile": "Dockerfile",
4-
"appPort": 3000,
54
"extensions": [
65
"dbaeumer.vscode-eslint"
76
]

containers/javascript-node-8/.vscode/launch.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
"type": "node",
99
"request": "launch",
1010
"name": "Launch Program",
11-
"program": "${workspaceFolder}/test-project/server.js"
11+
"program": "${workspaceFolder}/test-project/server.js",
12+
"cwd": "${workspaceFolder}/test-project",
13+
"preLaunchTask": "npm: install - test-project"
1214
}
1315
]
1416
}

containers/javascript-node-8/README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,42 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Node.js, JavaScript |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).
15+
This definition does require any special steps to use. Just follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

19-
If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Node.js 8 definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/javascript-node-8/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
32+
33+
## Testing the definition
34+
35+
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
36+
37+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
38+
2. Clone this repository.
39+
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
40+
4. Select the `containers/javascript-node-8` folder.
41+
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project. This will automatically run `npm install` before starting it.
42+
6. Once the project is running, press <kbd>F1</kbd> and select **Remote-Containers: Forward Port...**
43+
7. Select port 3000 and click the "Open Browser" button in the notification that appears.
44+
8. You should see "Hello remote world!" after the page loads.
45+
9. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
2046

2147
## License
2248

2349
Copyright (c) Microsoft Corporation. All rights reserved.
2450

25-
Licensed under the MIT License. See [LICENSE](../../LICENSE).
51+
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).

0 commit comments

Comments
 (0)