{"id":13560972,"url":"https://github.com/dotnet/eShop","last_synced_at":"2025-04-03T16:31:44.395Z","repository":{"id":207202767,"uuid":"706944893","full_name":"dotnet/eShop","owner":"dotnet","description":"A reference .NET application implementing an eCommerce site","archived":false,"fork":false,"pushed_at":"2024-10-28T01:46:23.000Z","size":25177,"stargazers_count":6140,"open_issues_count":102,"forks_count":1792,"subscribers_count":119,"default_branch":"main","last_synced_at":"2024-10-29T14:51:14.301Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-18T23:00:45.000Z","updated_at":"2024-10-29T12:42:17.000Z","dependencies_parsed_at":"2024-04-29T00:30:29.870Z","dependency_job_id":"b8ec0f84-76fa-47f1-8f0a-33b7ce319ce7","html_url":"https://github.com/dotnet/eShop","commit_stats":{"total_commits":243,"total_committers":47,"mean_commits":5.170212765957447,"dds":0.5555555555555556,"last_synced_commit":"414938c0613662a98637fc87434a2761eca33f75"},"previous_names":["dotnet/eshop"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2FeShop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2FeShop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2FeShop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2FeShop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotnet","download_url":"https://codeload.github.com/dotnet/eShop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247037044,"owners_count":20873085,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:00:51.289Z","updated_at":"2025-04-03T16:31:44.389Z","avatar_url":"https://github.com/dotnet.png","language":"C#","funding_links":[],"categories":["others","Open Source Projects","Sample Projects","C# #","General"],"sub_categories":["Tools","Workflow","Get started"],"readme":"# eShop Reference Application - \"AdventureWorks\"\n\nA reference .NET application implementing an e-commerce website using a services-based architecture using [.NET Aspire](https://learn.microsoft.com/dotnet/aspire/).\n\n![eShop Reference Application architecture diagram](img/eshop_architecture.png)\n\n![eShop homepage screenshot](img/eshop_homepage.png)\n\n## Getting Started\n\nThis version of eShop is based on .NET 9. \n\nPrevious eShop versions:\n* [.NET 8](https://github.com/dotnet/eShop/tree/release/8.0)\n\n### Prerequisites\n\n- Clone the eShop repository: https://github.com/dotnet/eshop\n- [Install \u0026 start Docker Desktop](https://docs.docker.com/engine/install/)\n\n#### Windows with Visual Studio\n- Install [Visual Studio 2022 version 17.10 or newer](https://visualstudio.microsoft.com/vs/).\n  - Select the following workloads:\n    - `ASP.NET and web development` workload.\n    - `.NET Aspire SDK` component in `Individual components`.\n    - Optional: `.NET Multi-platform App UI development` to run client apps\n\nOr\n\n- Run the following commands in a Powershell \u0026 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.)\n\n```powershell\ninstall-Module -Name Microsoft.WinGet.Configuration -AllowPrerelease -AcceptLicense -Force\n$env:Path = [System.Environment]::GetEnvironmentVariable(\"Path\",\"Machine\") + \";\" + [System.Environment]::GetEnvironmentVariable(\"Path\",\"User\")\nget-WinGetConfiguration -file .\\.configurations\\vside.dsc.yaml | Invoke-WinGetConfiguration -AcceptConfigurationAgreements\n```\n\nOr\n\n- From Dev Home go to `Machine Configuration -\u003e Clone repositories`. Enter the URL for this repository. In the confirmation screen look for the section `Configuration File Detected` and click `Run File`.\n\n#### Mac, Linux, \u0026 Windows without Visual Studio\n- Install the latest [.NET 9 SDK](https://dot.net/download?cid=eshop)\n\nOr\n\n- Run the following commands in a Powershell \u0026 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.)\n\n##### Install Visual Studio Code and related extensions\n```powershell\ninstall-Module -Name Microsoft.WinGet.Configuration -AllowPrerelease -AcceptLicense  -Force\n$env:Path = [System.Environment]::GetEnvironmentVariable(\"Path\",\"Machine\") + \";\" + [System.Environment]::GetEnvironmentVariable(\"Path\",\"User\")\nget-WinGetConfiguration -file .\\.configurations\\vscode.dsc.yaml | Invoke-WinGetConfiguration -AcceptConfigurationAgreements\n```\n\n\u003e Note: These commands may require `sudo`\n\n- Optional: Install [Visual Studio Code with C# Dev Kit](https://code.visualstudio.com/docs/csharp/get-started)\n- Optional: Install [.NET MAUI Workload](https://learn.microsoft.com/dotnet/maui/get-started/installation?tabs=visual-studio-code)\n\n\u003e Note: When running on Mac with Apple Silicon (M series processor), Rosetta 2 for grpc-tools. \n\n### Running the solution\n\n\u003e [!WARNING]\n\u003e Remember to ensure that Docker is started\n\n* (Windows only) Run the application from Visual Studio:\n - Open the `eShop.Web.slnf` file in Visual Studio\n - Ensure that `eShop.AppHost.csproj` is your startup project\n - Hit Ctrl-F5 to launch Aspire\n\n* Or run the application from your terminal:\n```powershell\ndotnet run --project src/eShop.AppHost/eShop.AppHost.csproj\n```\nthen look for lines like this in the console output in order to find the URL to open the Aspire dashboard:\n```sh\nLogin to the dashboard at: http://localhost:19888/login?t=uniquelogincodeforyou\n```\n\n\u003e 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\n\n### Azure Open AI\n\nWhen using Azure OpenAI, inside *eShop.AppHost/appsettings.json*, add the following section:\n\n```json\n  \"ConnectionStrings\": {\n    \"OpenAi\": \"Endpoint=xxx;Key=xxx;\"\n  }\n```\n\nReplace the values with your own. Then, in the eShop.AppHost *Program.cs*, set this value to **true**\n\n```csharp\nbool useOpenAI = false;\n```\n\nHere's additional guidance on the [.NET Aspire OpenAI component](https://learn.microsoft.com/dotnet/aspire/azureai/azureai-openai-component?tabs=dotnet-cli). \n\n### Use Azure Developer CLI\n\nYou can use the [Azure Developer CLI](https://aka.ms/azd) to run this project on Azure with only a few commands. Follow the next instructions:\n\n- Install the latest or update to the latest [Azure Developer CLI (azd)](https://aka.ms/azure-dev/install).\n- Log in `azd` (if you haven't done it before) to your Azure account:\n```sh\nazd auth login\n```\n- Initialize `azd` from the root of the repo.\n```sh\nazd init\n```\n- During init:\n  - Select `Use code in the current directory`. Azd will automatically detect the .NET Aspire project.\n  - Confirm `.NET (Aspire)` and continue.\n  - Select which services to expose to the Internet (exposing `webapp` is enough to test the sample).\n  - Finalize the initialization by giving a name to your environment.\n\n- Create Azure resources and deploy the sample by running:\n```sh\nazd up\n```\nNotes:\n  - The operation takes a few minutes the first time it is ever run for an environment.\n  - At the end of the process, `azd` will display the `url` for the webapp. Follow that link to test the sample.\n  - You can run `azd up` after saving changes to the sample to re-deploy and update the sample.\n  - Report any issues to [azure-dev](https://github.com/Azure/azure-dev/issues) repo.\n  - [FAQ and troubleshoot](https://learn.microsoft.com/azure/developer/azure-developer-cli/troubleshoot?tabs=Browser) for azd.\n\n## Contributing\n\nFor more information on contributing to this repo, read [the contribution documentation](./CONTRIBUTING.md) and [the Code of Conduct](CODE-OF-CONDUCT.md).\n\n### Sample data\n\nThe sample catalog data is defined in [catalog.json](https://github.com/dotnet/eShop/blob/main/src/Catalog.API/Setup/catalog.json). Those product names, descriptions, and brand names are fictional and were generated using [GPT-35-Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/chatgpt), and the corresponding [product images](https://github.com/dotnet/eShop/tree/main/src/Catalog.API/Pics) were generated using [DALL·E 3](https://openai.com/dall-e-3).\n\n## eShop on Azure\n\nFor a version of this app configured for deployment on Azure, please view [the eShop on Azure](https://github.com/Azure-Samples/eShopOnAzure) repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2FeShop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotnet%2FeShop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2FeShop/lists"}