Skip to content

docs: added a local setup guide #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Conversation

Vemarthula-Microsoft
Copy link
Contributor

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:

  • Added a detailed docs/LocalSetupGuide.md file covering prerequisites, environment setup, deployment steps, and component-specific instructions for both backend and frontend development.
  • Included sections for debugging, troubleshooting common issues (such as port conflicts, authentication, and CORS), and links to further resources and support.

Environment and deployment guidance:

  • Provided instructions for using VS Code Dev Containers, setting up .env files, and configuring Azure resources and permissions.
  • Documented how to run and debug each service (API, processor, and web frontend) locally, including sample launch.json configurations for VS Code.

Troubleshooting and support:

  • Added a troubleshooting section with solutions for common development environment problems and guidance on enabling debug logging.

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

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.

1 participant