Skip to content

Conversation

Dhruvkumar-Microsoft
Copy link
Contributor

Purpose

This pull request updates the deployment documentation to clarify and correct the installation and startup steps for both the backend and frontend. The main improvements include separating backend and frontend installation instructions, updating backend dependency management to use uv, and clarifying the commands to run the application.

Documentation improvements:

  • Updated backend installation instructions to use uv for dependency management instead of pip install -r requirements.txt, and clarified the directory structure for running these commands.
  • Added separate, explicit instructions for installing frontend requirements, specifying to run pip install -r requirements.txt in the src/frontend folder.

Application startup instructions:

  • Clarified that the backend should be started from the src/backend directory after activating the virtual environment, and updated the step description for accuracy.
  • Added an alternative command (npm run dev) for running the frontend server, in addition to the existing Python command.
  • Updated the step numbering and clarified the URLs for accessing the frontend and Swagger API documentation.

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit bbb83ad into dev Sep 4, 2025
9 checks passed
@Roopan-Microsoft Roopan-Microsoft deleted the psl-bug-22757-docs branch September 4, 2025 08:08
@github-actions
Copy link

🎉 This PR is included in version 2.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

2 participants