Skip to content

docs: added a local setup guide#193

Merged
Roopan-Microsoft merged 4 commits into
devfrom
ve-Local-readme
Aug 18, 2025
Merged

docs: added a local setup guide#193
Roopan-Microsoft merged 4 commits into
devfrom
ve-Local-readme

Conversation

@Vemarthula-Microsoft

Copy link
Copy Markdown
Contributor

Purpose

This pull request adds a comprehensive local development setup guide for the project. The new LocalSetupGuide.md provides detailed, step-by-step instructions for configuring the development environment, running the application locally, debugging, and troubleshooting common issues.

Key additions in documentation:

  • Added docs/LocalSetupGuide.md with instructions for prerequisites, environment setup, and running the solution accelerator locally, including VS Code Dev Containers and Docker options.
  • Included sections on backend and frontend debugging, agent system debugging, and troubleshooting frequent setup and runtime issues.
  • Provided detailed steps for environment variable configuration, Azure CLI login, resource group and infrastructure deployment, and role assignments for local development.
  • Added guidance for using custom Cosmos DB databases and enabling debug mode via environment variables.
  • Linked to the production deployment guide for further deployment instructions.

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

@Roopan-Microsoft
Roopan-Microsoft merged commit 4257161 into dev Aug 18, 2025
7 checks passed
Ritesh-Microsoft pushed a commit that referenced this pull request Oct 10, 2025
docs: added a local setup guide
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.5.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Priyanka-Microsoft
Priyanka-Microsoft deleted the ve-Local-readme branch December 25, 2025 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants