docs: added a local setup guide #245
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces a comprehensive local development guide for the project. The new
LocalSetupGuide.md
file provides step-by-step instructions for setting up the development environment, deploying resources, running and debugging the solution locally, and troubleshooting common issues. This documentation is intended to streamline onboarding and improve the developer experience.The most important changes are:
New developer documentation:
docs/LocalSetupGuide.md
file covering prerequisites, environment setup, deployment steps, and component-specific instructions for both backend and frontend development.Environment and deployment guidance:
.env
files, and configuring Azure resources and permissions.launch.json
configurations for VS Code.Troubleshooting and support:
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information