Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 3.3 KB

devcontainerreadme.md

File metadata and controls

36 lines (23 loc) · 3.3 KB
Raw

Dev container

This project includes a dev container, which lets you use a container as a full-featured dev environment.

You can use the dev container configuration in this folder to build and run the app without needing to install any of its tools locally! You can use it in GitHub Codespaces or the VS Code Dev Containers extension.

GitHub Codespaces

Follow these steps to open this sample in a Codespace:

  1. Click the Code drop-down menu at the top of https://github.com/dotnet-architecture/eShopOnWeb.
  2. Click on the Codespaces tab.
  3. Click Create codespace on main .

For more info, check out the GitHub documentation.

VS Code Dev Containers

If you already have VS Code and Docker installed, you can click here to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

You can also follow these steps to open this sample in a container using the VS Code Dev Containers extension:

  1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the getting started steps.

  2. Open a locally cloned copy of the code:

    • Clone this repository to your local filesystem.
    • Press F1 and select the Dev Containers: Open Folder in Container... command.
    • Select the cloned copy of this folder, wait for the container to start, and try things out!

You can learn more in the Dev Containers documentation.

Tips and tricks

  • Since the dev container is Linux-based, you won't be able to use LocalDB. Add "UseOnlyInMemoryDatabase": true, to the appsettings.json file (there's additional context on this in the app's readme).
  • If you get a 502 bad gateway error, you may need to set your port to the https protocol. You can do this by opening the Ports view in VS Code (Ports: Focus on Ports View), right-clicking on the port you're using, select Change Port Protocol, and set https.
  • If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The .gitattributes file in the root of this repo disables line ending conversion and should prevent this. See tips and tricks for more info.
  • If you'd like to review the contents of the image used in this dev container, you can check it out in the devcontainers/images repo.