Files
notifications-admin/docs/docker-remote-containers.md
Carlo Costino 206247f543 Clean up typos
This changeset cleans up a variety of typos that were found and submitted in PR #2588; we cannot directly accept external contributions, but we appreciate the flagging of things like this!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-05-21 17:01:01 -04:00

1.1 KiB

VS Code && Docker installation

If you're working in VS Code, you can also leverage Docker for a containerized dev environment

  1. Get the API running, including the Docker network

  2. Uncomment the Local Docker setup lines in .env and comment out the Local direct setup lines.

  3. Install the Remote-Containers plug-in in VS Code

  4. Using the command palette (shift+cmd+p) or green button thingy in the bottom left, search and select “Remote Containers: Open Folder in Container...” When prompted, choose devcontainer-admin folder (note: this is a subfolder of notifications-admin). This will start the container in a new window, replacing the current one.

  5. Wait a few minutes while things happen 🍵

  6. Open a VS Code terminal and run the Flask application:

    make run-flask

  7. Go to http://localhost:6012

NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code should detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command palette or just docker rm the notifications-api container.