Skip to content

Commit f0ce438

Browse files
author
Shreyas-Microsoft
committed
update the doc
1 parent a3155fa commit f0ce438

1 file changed

Lines changed: 24 additions & 61 deletions

File tree

docs/LocalDevelopmentSetup.md

Lines changed: 24 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -134,50 +134,6 @@ cd Modernize-your-code-solution-accelerator
134134

135135
## Step 2: Development Tools Setup
136136

137-
### Visual Studio Code (Recommended)
138-
139-
#### Required Extensions
140-
141-
Create `.vscode/extensions.json` in the workspace root:
142-
143-
```json
144-
{
145-
"recommendations": [
146-
"ms-python.python",
147-
"ms-python.pylint",
148-
"ms-python.black-formatter",
149-
"ms-python.isort",
150-
"ms-vscode-remote.remote-wsl",
151-
"ms-vscode-remote.remote-containers",
152-
"redhat.vscode-yaml",
153-
"ms-vscode.azure-account",
154-
"ms-python.mypy-type-checker"
155-
]
156-
}
157-
```
158-
159-
VS Code will prompt you to install these recommended extensions when you open the workspace.
160-
161-
#### Settings Configuration
162-
163-
Create `.vscode/settings.json`:
164-
165-
```json
166-
{
167-
"python.defaultInterpreterPath": "./.venv/bin/python",
168-
"python.terminal.activateEnvironment": true,
169-
"python.formatting.provider": "black",
170-
"python.linting.enabled": true,
171-
"python.linting.pylintEnabled": true,
172-
"python.testing.pytestEnabled": true,
173-
"python.testing.unittestEnabled": false,
174-
"files.associations": {
175-
"*.yaml": "yaml",
176-
"*.yml": "yaml"
177-
}
178-
}
179-
```
180-
181137
### Development Container Setup (Optional)
182138

183139
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all required tooling pre-configured.
@@ -300,8 +256,6 @@ az role assignment create \
300256
#### Other Required Roles
301257
Depending on the features you use, you may also need:
302258
- **Storage Blob Data Contributor** - For Azure Storage operations
303-
- **Storage Queue Data Contributor** - For queue-based processing
304-
- **Azure AI Developer** - For Azure AI Foundry access
305259

306260
**Note**: RBAC permission changes can take 5-10 minutes to propagate. If you encounter "Forbidden" errors after assigning roles, wait a few minutes and try again.
307261

@@ -334,20 +288,33 @@ Edit the `.env` file with your Azure configuration. Find these values from:
334288

335289
**Key configuration values:**
336290
```bash
337-
# Azure App Configuration URL
338-
APP_CONFIGURATION_URL=https://[your-app-config-name].azconfig.io
339-
340-
# Cosmos DB settings
341-
AZURE_COSMOS_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/
342-
AZURE_COSMOS_DATABASE=modernize-code
291+
# CosmosDB Configuration
292+
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
293+
COSMOSDB_DATABASE=
294+
COSMOSDB_BATCH_CONTAINER=
295+
COSMOSDB_FILE_CONTAINER=
296+
COSMOSDB_LOG_CONTAINER=
343297

344298
# Azure OpenAI settings
345299
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
346-
AZURE_OPENAI_API_VERSION=2024-08-01-preview
347300

348-
# Logging configuration
349-
APP_LOGGING_LEVEL=INFO
350-
APP_ENV=dev
301+
# Azure Blob Storage Configuration
302+
AZURE_BLOB_ENDPOINT=
303+
AZURE_BLOB_ACCOUNT_NAME=
304+
AZURE_BLOB_CONTAINER_NAME=
305+
306+
# Azure AI Foundry Configuration
307+
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
308+
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
309+
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
310+
AZURE_AI_AGENT_PROJECT_NAME = ""
311+
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
312+
313+
# Basic application logging (default: INFO level)
314+
AZURE_BASIC_LOGGING_LEVEL=INFO
315+
APP_ENV = "dev"
316+
# Azure package logging (default: WARNING level to suppress INFO)
317+
AZURE_PACKAGE_LOGGING_LEVEL=WARNING
351318
```
352319

353320
### 4.3. Install Backend Dependencies
@@ -463,11 +430,7 @@ VITE_API_URL=http://localhost:8000/api
463430
> - ✅ Check **ID tokens**
464431
> - Click **Save**
465432
>
466-
> 3. **Scope Configuration:**
467-
> - Use `User.Read` for local development/testing
468-
> - For production, configure custom API scopes like `api://your-api-id/access_as_user`
469-
>
470-
> 4. **Restart Required:**
433+
> 3. **Restart Required:**
471434
> - After updating `.env`, **stop and restart** the frontend dev server
472435
> - Vite caches environment variables at startup
473436

0 commit comments

Comments
 (0)