vscode-dev-containers/containers/javascript-node-postgres

Node.js & PostgreSQL (Community)

Summary

Develop applications in Node.js and PostgreSQL. Includes Node.js, eslint, and yarn in a container linked to a Postgres DB container

Metadata	Value
Contributors	Mehant
Categories	Community, Languages
Definition type	Docker Compose
Works in Codespaces	Yes
Container host OS support	Linux, macOS, Windows
Container OS	Debian
Languages, platforms	Node.js, JavaScript, PostgreSQL DB

Description

This definition creates two containers, one for Node.js and one for PostgreSQL. VS Code will attach to the Node.js container, and from within that container the PostgreSQL container will be available on localhost port 5432. The default database is named postgres with a user of postgres whose password is postgres, and if desired this may be changed in docker-compose.yml. Data is stored in a volume named postgres-data.

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 10, 12, or 14.

build:
  context: .
  dockerfile: Dockerfile
  args:
    VARIANT: 12

You also can connect to PostgreSQL from an external tool when using VS Code by updating .devcontainer/devcontainer.json as follows:

"forwardPorts": [ "5432" ]

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 database container, allows "forwardPorts" in devcontainer.json function.
network_mode: service:db

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.

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-postgres 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! Successfully connected to database." 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.