eShop Reference Application - "AdventureWorks"

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

Getting Started

Prerequisites

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

Windows with Visual Studio

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

Run the following commands in a Powershell & Terminal running as Administrator 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

From Dev Home go to Machine Configuration -> Clone repositories. Enter the URL for this repository. In the confirmation screen look for the section Configuration File Detected and click Run File.

Mac, Linux, & Windows without Visual Studio

Install the latest .NET 8 SDK
Install the .NET Aspire workload with the following commands:

dotnet workload update
dotnet workload install aspire
dotnet restore eShop.Web.slnf

Run the following commands in a Powershell & Terminal running as Administrator 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 Visual Studio Code and related extensions

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 require sudo

Optional: Install Visual 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.

Running the solution

Warning

Remember to ensure that Docker is started

(Windows only) Run the application from Visual Studio:

Open the eShop.Web.slnf file in Visual Studio
Ensure that eShop.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 at https://aka.ms/aspnet/https-trust-dev-cert

Azure Open AI

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

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

Replace the values with your own. Then, in the eShop.AppHost Program.cs, set this value to true

bool useOpenAI = false;

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

Use Azure Developer CLI

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

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

azd auth login

Initialize azd from the root of the repo.

azd init

During init:
- Select Use 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 (exposing webapp 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 the url for the webapp. Follow that link to test the sample.
You can run azd up after saving changes to the sample to re-deploy and update the sample.
Report any issues to azure-dev repo.
FAQ and troubleshoot for azd.

Contributing

For more information on contributing to this repo, read the contribution documentation and the Code of Conduct.

Sample data

The sample catalog data is defined in catalog.json. Those product names, descriptions, and brand names are fictional and were generated using GPT-35-Turbo, and the corresponding product images were generated using DALL·E 3.

eShop on Azure

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

vhvb1989/eShop