docs: Doc change for the local installing requirement from uv instead of requirements.txt #440
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 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:
uv
for dependency management instead ofpip install -r requirements.txt
, and clarified the directory structure for running these commands.pip install -r requirements.txt
in thesrc/frontend
folder.Application startup instructions:
src/backend
directory after activating the virtual environment, and updated the step description for accuracy.npm run dev
) for running the frontend server, in addition to the existing Python command.Does this introduce a breaking change?
How to Test
What to Check
Verify that the following are valid
Other Information