Skip to content

Commit 62c5962

Browse files
authored
Update README.md about local env (#587)
* Update README.md about local env * Update README.md * Update README.md * Update README.md * Update README.md with terminal * Clarify VS Code remote
1 parent 376068b commit 62c5962

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
- [Getting started](#getting-started)
77
- [Azure deployment](#azure-deployment)
88
- [Cost estimation](#cost-estimation)
9-
- [Prerequisites](#prerequisites)
10-
- [To run locally](#to-run-locally)
11-
- [To run in GitHub Codespaces or VS Code Remote Containers](#to-run-in-github-codespaces-or-vs-code-remote-containers)
12-
- [Project initialization](#project-initialization)
9+
- [Project setup](#project-setup)
10+
- [GitHub Codespaces](#github-codespaces)
11+
- [VS Code Remote Containers](#vs-code-remote-containers)
12+
- [Local environment](#local-environment)
1313
- [Deploying from scratch](#deploying-from-scratch)
1414
- [Deploying with existing Azure resources](#deploying-with-existing-azure-resources)
1515
- [Deploying again](#deploying-again)
@@ -48,7 +48,9 @@ The repo includes sample data so it's ready to try end to end. In this sample ap
4848

4949
> **IMPORTANT:** In order to deploy and run this example, you'll need an **Azure subscription with access enabled for the Azure OpenAI service**. You can request access [here](https://aka.ms/oaiapply). You can also visit [here](https://azure.microsoft.com/free/cognitive-search/) to get some free Azure credits to get you started.
5050
51-
## Azure deployment
51+
> Your Azure Account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator) or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner).
52+
53+
## Azure deployment
5254

5355
### Cost estimation
5456

@@ -67,9 +69,27 @@ To reduce costs, you can switch to free SKUs for Azure App Service, Azure Cognit
6769
⚠️ To avoid unnecessary costs, remember to take down your app if it's no longer in use,
6870
either by deleting the resource group in the Portal or running `azd down`.
6971

70-
### Prerequisites
72+
### Project setup
73+
74+
You have a few options for setting up this project.
75+
The easiest way to get started is GitHub Codespaces, since it will setup all the tools for you,
76+
but you can also [set it up locally](#local-environment) if desired.
77+
78+
#### GitHub Codespaces
7179

72-
#### To run locally
80+
You can run this repo virtually by using GitHub Codespaces, which will open a web-based VS Code in your browser:
81+
82+
[![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=599293758&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
83+
84+
#### VS Code Remote Containers
85+
86+
A related option is VS Code Remote Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers):
87+
88+
[![Open in Remote - Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo)
89+
90+
#### Local environment
91+
92+
First install the required tools:
7393

7494
* [Azure Developer CLI](https://aka.ms/azure-dev/install)
7595
* [Python 3.9+](https://www.python.org/downloads/)
@@ -78,18 +98,9 @@ either by deleting the resource group in the Portal or running `azd down`.
7898
* [Node.js 14+](https://nodejs.org/en/download/)
7999
* [Git](https://git-scm.com/downloads)
80100
* [Powershell 7+ (pwsh)](https://github.com/powershell/powershell) - For Windows users only.
81-
* **Important**: Ensure you can run `pwsh.exe` from a PowerShell command. If this fails, you likely need to upgrade PowerShell.
82-
83-
>NOTE: Your Azure Account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator) or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner).
84-
85-
#### To Run in GitHub Codespaces or VS Code Remote Containers
86-
87-
You can run this repo virtually by using GitHub Codespaces or VS Code Remote Containers. Click on one of the buttons below to open this repo in one of those options.
88-
89-
[![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=599293758&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
90-
[![Open in Remote - Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo)
101+
* **Important**: Ensure you can run `pwsh.exe` from a PowerShell terminal. If this fails, you likely need to upgrade PowerShell.
91102

92-
### Project initialization
103+
Then bring down the project code:
93104

94105
1. Create a new folder and switch to it in the terminal
95106
1. Run `azd auth login`

0 commit comments

Comments
 (0)