Skip to content

README prerequisites are missing Docker requirement for running Azurite locally #2

@v-xuto

Description

@v-xuto

Description

The README currently lists Azurite as a prerequisite for local development, but it does not explicitly mention that Docker is also required when following the documented local run steps.

In the Run your app from the terminal section, the sample instructs users to start Azurite with:

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite

However, Docker is not included in the Prerequisites section. This can be confusing for users who follow the README from top to bottom, especially in a fresh local environment.

Image

Environment

  • OS: Windows
  • Azd version: azd version 1.25.2 (commit 528dda50b6688ced458182ae10b771156b698b1a) (stable)
  • Templates:
  1. https://github.com/Azure-Samples/functions-quickstart-python-azd-timer
  2. https://github.com/Azure-Samples/functions-quickstart-javascript-azd-timer
  3. https://github.com/Azure-Samples/functions-quickstart-typescript-azd-timer
  4. https://github.com/Azure-Samples/functions-quickstart-powershell-azd-timer
  5. https://github.com/Azure-Samples/functions-quickstart-java-azd-timer

Expected Behavior

The Prerequisites section should explicitly list Docker as a requirement for the local development flow that uses the documented Azurite container command.

Notes: The other four azd timer templates have the same issue as well, so please fix them together. I only opened one issue to avoid creating duplicate issues.

@im-samz, @hemarina for notification.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions