Skip to content

Conversation

@Shreyas-Microsoft
Copy link
Collaborator

Purpose

Successfully updated the LocalSetupGuide.md to follow the comprehensive structure and format of the reference document.

Summary of Changes
The updated guide now includes:

✅ Improved Introduction - Clear overview with multi-service architecture explanation
✅ Important Setup Notes - Terminal organization, path conventions, and configuration file details
✅ Step 1: Prerequisites - Platform-specific installation instructions for Windows (native & WSL2) and Linux
✅ Step 2: Development Tools - VS Code extensions, settings, and development container setup
✅ Step 3: Azure Infrastructure - Authentication, resource group creation, infrastructure deployment, and RBAC permissions
✅ Step 4: Backend Setup - Complete backend API configuration, dependencies, and startup instructions
✅ Step 5: Frontend Setup - Frontend installation, Azure AD configuration, and development server startup
✅ Step 6: Verification - Service status checklist and quick verification steps
✅ Step 7: Debugging - VS Code debugging configuration and logging setup
✅ Step 8: Docker - Optional containerized development instructions
✅ Comprehensive Troubleshooting - Expanded common issues with solutions and debug mode checklist
✅ Step 9: Next Steps - Clear guidance on what to do after setup
✅ Related Documentation - Updated links to other guides

The document now provides a professional, step-by-step guide with clear terminal organization, detailed explanations, and improved user experience following the reference format.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the local development setup guide by completely rewriting and expanding the LocalDevelopmentSetup.md documentation. The update follows a comprehensive structure similar to a reference document and significantly enhances the developer experience.

Key Changes:

  • Added detailed multi-service architecture explanation with terminal organization guidance
  • Included platform-specific installation instructions (Windows native, WSL2, and Linux distributions)
  • Expanded Azure infrastructure deployment steps with RBAC permission requirements
  • Added comprehensive troubleshooting section with common issues and solutions
  • Included new frontend_env_variables.png image to help users configure environment variables

Reviewed changes

Copilot reviewed 1 out of 3 changed files in this pull request and generated 11 comments.

File Description
docs/LocalDevelopmentSetup.md New comprehensive local development setup guide with step-by-step instructions for prerequisites, development tools, Azure infrastructure, backend/frontend setup, debugging, Docker, and troubleshooting
docs/images/frontend_env_variables.png New screenshot image showing frontend environment variable configuration reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +309 to +313
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment statement has inconsistent spacing. There should be a space after the equals sign to match the formatting style used throughout the rest of the document.

Suggested change
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=""
AZURE_AI_AGENT_SUBSCRIPTION_ID=""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME=""
AZURE_AI_AGENT_PROJECT_NAME=""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=""

Copilot uses AI. Check for mistakes.
Comment on lines +294 to +311
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=

# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/

# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=

# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable assignment has trailing space after the equals sign. For consistency with other environment variable examples in the document, remove the trailing space.

Suggested change
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
COSMOSDB_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=""
AZURE_AI_AGENT_SUBSCRIPTION_ID=""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME=""

Copilot uses AI. Check for mistakes.
Comment on lines +294 to +317
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=

# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/

# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=

# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""

# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable assignment has trailing space after the equals sign. For consistency with other environment variable examples in the document, remove the trailing space.

Suggested change
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
COSMOSDB_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=""
AZURE_AI_AGENT_SUBSCRIPTION_ID=""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME=""
AZURE_AI_AGENT_PROJECT_NAME=""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV="dev"

Copilot uses AI. Check for mistakes.
Comment on lines +294 to +317
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=

# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/

# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=

# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""

# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable assignment has trailing space after the equals sign. For consistency with other environment variable examples in the document, remove the trailing space.

Suggested change
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
COSMOSDB_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=""
AZURE_AI_AGENT_SUBSCRIPTION_ID=""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME=""
AZURE_AI_AGENT_PROJECT_NAME=""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV="dev"

Copilot uses AI. Check for mistakes.
Comment on lines +309 to +313
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment statement has inconsistent spacing. There should be a space after the equals sign to match the formatting style used throughout the rest of the document.

Suggested change
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING= ""
AZURE_AI_AGENT_SUBSCRIPTION_ID= ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME= ""
AZURE_AI_AGENT_PROJECT_NAME= ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME= ""

Copilot uses AI. Check for mistakes.
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment statement has inconsistent spacing. There should be a space after the equals sign to match the formatting style used throughout the rest of the document.

Copilot uses AI. Check for mistakes.
Comment on lines +298 to +317
COSMOSDB_LOG_CONTAINER=

# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/

# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=

# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""

# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment statement has inconsistent spacing. There should be a space after the equals sign to match the formatting style used throughout the rest of the document.

Suggested change
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING = ""
AZURE_AI_AGENT_SUBSCRIPTION_ID = ""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME = ""
AZURE_AI_AGENT_PROJECT_NAME = ""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME = ""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
# Azure AI Foundry Configuration
AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=""
AZURE_AI_AGENT_SUBSCRIPTION_ID=""
AZURE_AI_AGENT_RESOURCE_GROUP_NAME=""
AZURE_AI_AGENT_PROJECT_NAME=""
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=""
# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV="dev"

Copilot uses AI. Check for mistakes.

# Basic application logging (default: INFO level)
AZURE_BASIC_LOGGING_LEVEL=INFO
APP_ENV = "dev"
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment statement has inconsistent spacing. There should be a space after the equals sign to match the formatting style used throughout the rest of the document.

Suggested change
APP_ENV = "dev"
APP_ENV= "dev"

Copilot uses AI. Check for mistakes.
**Key configuration values:**
```bash
# CosmosDB Configuration
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable assignment is missing a space after the equals sign. For consistency with other environment variable examples in the document, change the format to have no spaces around the equals sign.

Suggested change
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/

Copilot uses AI. Check for mistakes.
Comment on lines +294 to +306
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=

# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/

# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable assignment is missing a space after the equals sign and has an extra trailing space. For consistency with other environment variable examples in the document, change the format to have no spaces around the equals sign.

Suggested change
COSMOSDB_ENDPOINT= https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=
COSMOSDB_ENDPOINT=https://[your-cosmos-account].documents.azure.com:443/
COSMOSDB_DATABASE=
COSMOSDB_BATCH_CONTAINER=
COSMOSDB_FILE_CONTAINER=
COSMOSDB_LOG_CONTAINER=
# Azure OpenAI settings
AZURE_OPENAI_ENDPOINT=https://[your-openai-resource].openai.azure.com/
# Azure Blob Storage Configuration
AZURE_BLOB_ENDPOINT=
AZURE_BLOB_ACCOUNT_NAME=
AZURE_BLOB_CONTAINER_NAME=

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants