Repository files navigation

A reference .NET application implementing an e-commerce website using a services-based architecture using.NET Aspire.

This version of eShop is based on .NET 9.

Previous eShop versions:

• .NET 8

• Clone the eShop repository:https://github.com/dotnet/eshop
• Install & start Docker Desktop

• InstallVisual Studio 2022 version 17.10 or newer.
  • Select the following workloads:
    • ASP.NET and web development workload.
    • .NET Aspire SDK component inIndividual components.
    • Optional:.NET Multi-platform App UI development to run client apps

Or

• Run the following commands in a Powershell & Terminal running asAdministrator to automatically configure your environment with the required tools to build and run this application. (Note: A restart is required and included in the script below.)

install-Module-Name Microsoft.WinGet.Configuration-AllowPrerelease-AcceptLicense-Force$env:Path= [System.Environment]::GetEnvironmentVariable("Path","Machine")+";"+ [System.Environment]::GetEnvironmentVariable("Path","User")get-WinGetConfiguration-file .\.configurations\vside.dsc.yaml|Invoke-WinGetConfiguration-AcceptConfigurationAgreements

Or

• From Dev Home go toMachine Configuration -> Clone repositories. Enter the URL for this repository. In the confirmation screen look for the sectionConfiguration File Detected and clickRun File.

• Install the latest.NET 9 SDK

Or

• Run the following commands in a Powershell & Terminal running asAdministrator to automatically configuration your environment with the required tools to build and run this application. (Note: A restart is required after running the script below.)

install-Module-Name Microsoft.WinGet.Configuration-AllowPrerelease-AcceptLicense-Force$env:Path= [System.Environment]::GetEnvironmentVariable("Path","Machine")+";"+ [System.Environment]::GetEnvironmentVariable("Path","User")get-WinGetConfiguration-file .\.configurations\vscode.dsc.yaml|Invoke-WinGetConfiguration-AcceptConfigurationAgreements

Note: These commands may requiresudo

• Optional: InstallVisual Studio Code with C# Dev Kit
• Optional: Install.NET MAUI Workload

Note: When running on Mac with Apple Silicon (M series processor), Rosetta 2 for grpc-tools.

• (Windows only) Run the application from Visual Studio:

• Open theeShop.Web.slnf file in Visual Studio
• Ensure thateShop.AppHost.csproj is your startup project
• Hit Ctrl-F5 to launch Aspire

• Or run the application from your terminal:

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

then look for lines like this in the console output in order to find the URL to open the Aspire dashboard:

Login to the dashboard at: http://localhost:19888/login?t=uniquelogincodeforyou

You may need to install ASP.NET Core HTTPS development certificates first, and then close all browser tabs. Learn more athttps://aka.ms/aspnet/https-trust-dev-cert

When using Azure OpenAI, insideeShop.AppHost/appsettings.json, add the following section:

"ConnectionStrings": {"OpenAi":"Endpoint=xxx;Key=xxx;"  }

Replace the values with your own. Then, in the eShop.AppHostProgram.cs, set this value totrue

booluseOpenAI=false;

Here's additional guidance on the.NET Aspire OpenAI component.

You can use theAzure Developer CLI to run this project on Azure with only a few commands. Follow the next instructions:

• Install the latest or update to the latestAzure Developer CLI (azd).
• Log inazd (if you haven't done it before) to your Azure account:

azd auth login

• Initializeazd from the root of the repo.

azd init

• During init:

  • SelectUse code in the current directory. Azd will automatically detect the .NET Aspire project.
  • Confirm.NET (Aspire) and continue.
  • Select which services to expose to the Internet (exposingwebapp is enough to test the sample).
  • Finalize the initialization by giving a name to your environment.

• Create Azure resources and deploy the sample by running:

azd up

Notes:

• The operation takes a few minutes the first time it is ever run for an environment.
• At the end of the process,azd will display theurl for the webapp. Follow that link to test the sample.
• You can runazd up after saving changes to the sample to re-deploy and update the sample.
• Report any issues toazure-dev repo.
• FAQ and troubleshoot for azd.

For more information on contributing to this repo, readthe contribution documentation andthe Code of Conduct.

The sample catalog data is defined incatalog.json. Those product names, descriptions, and brand names are fictional and were generated usingGPT-35-Turbo, and the correspondingproduct images were generated usingDALL·E 3.

For a version of this app configured for deployment on Azure, please viewthe eShop on Azure repo.