diff --git a/README.md b/README.md index 593c53e6..1fa63751 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,40 @@ Now listening on: http://localhost:18848 The 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). -### Contributing +## Use Azure Developer CLI + +You 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: + +- Install [azd](https://aka.ms/azure-dev/install). +- Log in `azd` (if you haven't done it before) to your Azure account: +```sh +azd auth login +``` +- Initialize `azd` from the root of the repo. +```sh +azd init +``` +- During init: + - Select `Use code in the current directory`. Azd will automatically detect the Dotnet 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: +```sh +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](https://github.com/Azure/azure-dev/issues) repo. + - [FAQ and troubleshoot](https://learn.microsoft.com/azure/developer/azure-developer-cli/troubleshoot?tabs=Browser) for azd. + +## Contributing For more information on contributing to this repo, please read [the contribution documentation](./CONTRIBUTING.md) and [the Code of Conduct](CODE-OF-CONDUCT.md). -### eShop on Azure +## eShop on Azure For a version of this app configured for deployment on Azure, please view [the eShop on Azure](https://github.com/Azure-Samples/eShopOnAzure) repo.