Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 4.42 KB

README.md

File metadata and controls

81 lines (56 loc) · 4.42 KB

Node.js & JavaScript

Summary

Develop Node.js based applications. Includes Node.js, eslint, nvm, and yarn.

Metadata Value
Contributors The VS Code Team
Definition type Dockerfile
Published image mcr.microsoft.com/vscode/devcontainers/javascript-node
Available image variants 10, 12, 14
Published image architecture(s) x86-64
Works in Codespaces Yes
Container host OS support Linux, macOS, Windows
Languages, platforms Node.js, JavaScript

Using this definition with an existing folder

While the definition itself works unmodified, you can select the version of Node.js the container uses by updating the VARIANT arg in the included devcontainer.json (and rebuilding if you've already created the container).

"args": { "VARIANT": "12" }

You can also directly reference pre-built versions of .devcontainer/base.Dockerfile by using the image property in .devcontainer/devcontainer.json or updating the FROM statement in your own Dockerfile with one of the following:

  • mcr.microsoft.com/vscode/devcontainers/javascript-node (latest)
  • mcr.microsoft.com/vscode/devcontainers/javascript-node:14
  • mcr.microsoft.com/vscode/devcontainers/javascript-node:12
  • mcr.microsoft.com/vscode/devcontainers/javascript-node:10

Version specific tags tied to releases in this repository are also available.

  • mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14
  • mcr.microsoft.com/vscode/devcontainers/javascript-node:0.123-14
  • mcr.microsoft.com/vscode/devcontainers/javascript-node:0.123.0-14

Alternatively, you can use the contents of the Dockerfile to fully customize your container's contents or to build it for a container host architecture not supported by the image.

Beyond Node.js and git, this image / Dockerfile includes eslint, zsh, Oh My Zsh!, a non-root vscode user with sudo access, and a set of common dependencies for development. Node Version Manager (nvm) is also included in case you need to use a different version of Node.js than the one included in the image.

Adding the definition to your project

Just follow these steps:

  1. If this is your first time using a development container, please follow the getting started steps to set up your machine.

  2. To use the pre-built image:

    1. Start VS Code and open your project folder.
    2. Press F1 select and Remote-Containers: Add Development Container Configuration Files... from the command palette.
    3. Select the Node.js 14 definition.

  3. To use the Dockerfile for this definition (rather than the pre-built image):

    1. Clone this repository.
    2. Copy the contents of containers/javascript-node/.devcontainer to the root of your project folder.
    3. Start VS Code and open your project folder.

  4. After following step 2 or 3, the contents of the .devcontainer folder in your project can be adapted to meet your needs.

  5. Finally, press F1 and run Remote-Containers: Reopen Folder in Container to start using the definition.

Testing the definition

This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:

  1. If this is your first time using a development container, please follow the getting started steps to set up your machine.
  2. Clone this repository.
  3. Start VS Code, press F1, and select Remote-Containers: Open Folder in Container...
  4. Select the containers/javascript-node folder.
  5. After the folder has opened in the container, press F5 to start the project. This will automatically run npm install before starting it.
  6. Once the project is running, press F1 and select Remote-Containers: Forward Port from Container...
  7. Select port 3000 and click the "Open Browser" button in the notification that appears.
  8. You should see "Hello remote world!" after the page loads.
  9. From here, you can add breakpoints or edit the contents of the test-project folder to do further testing.

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See LICENSE.