vscode-dev-containers/containers/javascript-node-azurite
Samruddhi Khandale e9ec96aee7 Stops publishing and supporting Templates 2023-11-15 16:42:19 +00:00
..
.devcontainer use new image path 2022-10-10 22:12:22 +00:00
.vscode Added devcontainer for node and azurite 2020-09-13 22:48:34 +02:00
test-project Fix test (CI Ignore) 2021-08-20 14:59:37 +00:00
.npmignore Added devcontainer for node and azurite 2020-09-13 22:48:34 +02:00
README.md Stops publishing and supporting Templates 2023-11-15 16:42:19 +00:00

README.md

IMPORTANT NOTE: This Template is deprecated and is no longer supported.

Node.js & Azurite (Community)

Summary

Everything you need to get started using Node with Azurite.

Metadata Value
Contributors Alexander Wennerstrøm
Categories Community, Azure
Definition type Docker Compose
Works in Codespaces Yes
Container host OS support Linux, macOS, Windows
Languages, platforms Azurite, Node.js

Using this definition

This setup creates two containers, one for Node.js and one for Azurite. Both will be accessable on localhost, Blob storage will be available on port 10000 and queue will be available on port 10001

While the definition itself works unmodified, it uses the mcr.microsoft.com/vscode/devcontainers/javascript-node image which includes git, eslint, zsh, Oh My Zsh!, a non-root vscode user with sudo access, and a set of common dependencies for development. You can pick a different version of this image by updating the VARIANT arg in .devcontainer/docker-compose.yml to pick either Node.js version.

build:
  context: .
  dockerfile: Dockerfile
  args:
    # Update 'VARIANT' to pick an LTS version of Node.js: 16, 14, 12.
    # Append -bullseye or -buster to pin to an OS version.
    # Use -bullseye variants on local arm64/Apple Silicon.
    VARIANT: 14-bullseye

Adding another service

You can add other services to your docker-compose.yml file as described in Docker's documentaiton. However, if you want anything running in this service to be available in the container on localhost, or want to forward the service locally, be sure to add this line to the service config:

# Runs the service on the same network as the app container, allows "forwardPorts" in devcontainer.json function.
network_mode: service:app

Adding the definition to a project or codespace

  1. If this is your first time using a development container, please see getting started information on setting up Remote-Containers or creating a codespace using GitHub Codespaces.

  2. Start VS Code and open your project folder or connect to a codespace.

  3. Press F1 select and Add Development Container Configuration Files... command for Remote-Containers or Codespaces.

    Note: If needed, you can drag-and-drop the .devcontainer folder from this sub-folder in a locally cloned copy of this repository into the VS Code file explorer instead of using the command.

  4. Select this definition. You may also need to select Show All Definitions... for it to appear.

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

[Optional] 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 this folder from the cloned repository.
  5. [Provide any information on steps required to test the definition.]

[Optional] How it works

[If the definition provides a pattern you think will be useful for others, describe the it here.]

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See LICENSE.