Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 79 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,85 @@ A reference .NET application implementing an e-commerce website using a services

## Getting Started

This version of eShop is based on .NET 9.
[.NET 10 Support]
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section heading is missing proper Markdown formatting. Section headings should use hash symbols. This should be formatted as a proper heading level (e.g., ## .NET 10 Support or ### .NET 10 Support) to maintain consistent document structure.

Suggested change
[.NET 10 Support]
## .NET 10 Support

Copilot uses AI. Check for mistakes.

The eShop project now includes support for .NET 10 Preview, allowing developers to take advantage of the newest runtime improvements, performance updates, and ASP.NET Core features. While .NET 9 remains fully supported, users running newer SDKs can build and run the application on .NET 10 without making any code changes.
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation claims that .NET 9 remains fully supported, but the repository's global.json file explicitly specifies version "10.0.100", which forces the use of .NET 10. This creates a contradiction - developers cannot use .NET 9 if the global.json enforces .NET 10. Either the global.json should be updated to allow .NET 9, or this statement should be corrected to reflect the actual requirement.

Copilot uses AI. Check for mistakes.

Install the .NET 10 Preview SDK
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Install the .NET 10 Preview SDK) to be properly rendered and maintain document hierarchy.

Suggested change
Install the .NET 10 Preview SDK
### Install the .NET 10 Preview SDK

Copilot uses AI. Check for mistakes.

To run eShop using .NET 10, install the latest SDK from Microsoft:

Download: https://dotnet.microsoft.com/download/dotnet/10.0

Verify installation:

dotnet --version
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README (see lines 152-154, 110-114). This ensures proper syntax highlighting and consistent documentation formatting.

Copilot uses AI. Check for mistakes.


You should see a version starting with 10.0.

Running the application with .NET 10
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Running the application with .NET 10) to maintain consistent document structure.

Suggested change
Running the application with .NET 10
### Running the application with .NET 10

Copilot uses AI. Check for mistakes.

Once .NET 10 Preview is installed, you can run eShop exactly the same way:

dotnet run --project src/eShop.AppHost/eShop.AppHost.csproj
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README (see lines 152-154). This ensures proper syntax highlighting and consistent documentation formatting.

Copilot uses AI. Check for mistakes.


The Aspire dashboard should appear as usual, and all microservices will be launched through eShop.AppHost.

Global.json behavior
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Global.json behavior) to maintain consistent document structure. Note: The capitalization should match the actual filename "global.json" (all lowercase).

Suggested change
Global.json behavior
### global.json behavior

Copilot uses AI. Check for mistakes.

If your environment contains multiple .NET SDK versions, .NET 10 will be used automatically, unless the repo contains a global.json specifying another version.

To explicitly use .NET 10, you may create or update global.json:

{
"sdk": {
"version": "10.0.0-preview.1"
}
}
Comment on lines +43 to +47
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSON code block should be formatted with triple backticks and a language identifier (```json) to match the formatting style used elsewhere in the README (see lines 166-170) and ensure proper syntax highlighting.

Copilot uses AI. Check for mistakes.


(This step is optional but ensures consistency across development machines.)
Comment on lines +37 to +50
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement is misleading. The repository already contains a global.json file (which specifies version "10.0.100"). The documentation should accurately reflect that a global.json file already exists in the repository and explain its current configuration.

Suggested change
Global.json behavior
If your environment contains multiple .NET SDK versions, .NET 10 will be used automatically, unless the repo contains a global.json specifying another version.
To explicitly use .NET 10, you may create or update global.json:
{
"sdk": {
"version": "10.0.0-preview.1"
}
}
(This step is optional but ensures consistency across development machines.)
Global.json configuration
This repository already contains a `global.json` file at the root, which pins the .NET SDK version to `10.0.100` (a .NET 10 Preview release). This ensures that all contributors use the same SDK version when building and running the application, regardless of other SDKs installed on their machines.
The contents of the current `global.json` file are:
{
"sdk": {
"version": "10.0.100"
}
}
This means that, by default, the .NET 10 Preview SDK will be used when working with this repository. If you do not have this SDK version installed, you will need to install it to build and run the project.

Copilot uses AI. Check for mistakes.

Comment on lines +39 to +51
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This instruction is misleading. The repository already contains a global.json file that specifies version "10.0.100". The documentation should either explain the existing global.json configuration or clarify that users should not modify it if they want to follow the repository's standard configuration.

Suggested change
If your environment contains multiple .NET SDK versions, .NET 10 will be used automatically, unless the repo contains a global.json specifying another version.
To explicitly use .NET 10, you may create or update global.json:
{
"sdk": {
"version": "10.0.0-preview.1"
}
}
(This step is optional but ensures consistency across development machines.)
The repository already contains a `global.json` file specifying the .NET SDK version ("10.0.100"). This ensures that all contributors use the same SDK version, providing consistency across development environments.
**Note:** You should not modify or remove the `global.json` file if you want to follow the repository's standard configuration. If you need to use a different SDK version for your own purposes, be aware that this may lead to differences from the intended setup.

Copilot uses AI. Check for mistakes.
Compatibility Notes
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Compatibility Notes) to maintain consistent document structure.

Suggested change
Compatibility Notes
### Compatibility Notes

Copilot uses AI. Check for mistakes.

.NET 10 is still in preview, so APIs and tooling may change.

Some IDEs, such as Visual Studio, may require the latest preview version to fully support .NET 10 projects.

Docker container images for .NET 10 Preview must be pulled manually if using containerized builds.

Example Docker base image:

FROM mcr.microsoft.com/dotnet/aspnet:10.0-preview
Comment on lines +54 to +62
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bullet points in this section should be formatted as a proper Markdown list with dashes or asterisks at the beginning of each line. The current format lacks list markers, which makes the content harder to read and inconsistent with Markdown best practices.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code snippet should be formatted as a proper code block with triple backticks and a language identifier (e.g., ```dockerfile) to match the formatting style used elsewhere in the README and ensure proper syntax highlighting.

Copilot uses AI. Check for mistakes.

### Troubleshooting

If the project fails to build with .NET 10:

Ensure Docker Desktop is running

Rebuild NuGet packages:

dotnet restore --force
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README. This ensures proper syntax highlighting and consistent documentation formatting.

Copilot uses AI. Check for mistakes.


Clear old build outputs:

dotnet clean
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README. This ensures proper syntax highlighting and consistent documentation formatting.

Copilot uses AI. Check for mistakes.


Confirm your SDK version:

dotnet --list-sdks
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README. This ensures proper syntax highlighting and consistent documentation formatting.

Copilot uses AI. Check for mistakes.


If .NET 10 does not appear in the list, reinstall the SDK.

Comment on lines +68 to +86
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The troubleshooting items should be formatted as a proper Markdown list with dashes or asterisks. The current format lacks list markers and inconsistent indentation, making it harder to read and not following standard Markdown conventions used elsewhere in the README.

Suggested change
Ensure Docker Desktop is running
Rebuild NuGet packages:
dotnet restore --force
Clear old build outputs:
dotnet clean
Confirm your SDK version:
dotnet --list-sdks
If .NET 10 does not appear in the list, reinstall the SDK.
- Ensure Docker Desktop is running.
- Rebuild NuGet packages:

dotnet restore --force

- Clear old build outputs:

dotnet clean

- Confirm your SDK version:

dotnet --list-sdks

- If .NET 10 does not appear in the list, reinstall the SDK.

Copilot uses AI. Check for mistakes.
Ongoing updates
Copy link

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Ongoing updates) to maintain consistent document structure.

Suggested change
Ongoing updates
### Ongoing updates

Copilot uses AI. Check for mistakes.

As .NET 10 Preview evolves, the eShop team will continue updating this repository to ensure compatibility and incorporate new Aspire features. Developers are encouraged to report any preview-related issues through the GitHub issue tracker so they can be addressed before the final release.

Previous eShop versions:
* [.NET 8](https://github.com/dotnet/eShop/tree/release/8.0)
Expand Down