content-processing-solution-accelerator
content-processing-solution-accelerator copied to clipboard
docs: added a local setup guide
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.mdfile 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
.envfiles, and configuring Azure resources and permissions. - Documented how to run and debug each service (API, processor, and web frontend) locally, including sample
launch.jsonconfigurations 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
- [x] No
Golden Path Validation
- [x] I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.
Deployment Validation
- [x] 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
- ...