Skip to content

Commit bbb83ad

Browse files
Merge pull request #440 from microsoft/psl-bug-22757-docs
docs: Doc change for the local installing requirement from uv instead of requirements.txt
2 parents 32989a9 + 901c355 commit bbb83ad

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

docs/DeploymentGuide.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -370,16 +370,23 @@ The files for the dev container are located in `/.devcontainer/` folder.
370370
371371
- If you are using `venv`, create and activate your virtual environment for both the frontend and backend folders.
372372
373-
8. **Install requirements - frontend:**
373+
8. **Install requirements - Backend:**
374374
375-
- In each of the frontend and backend folders -
376-
Open a terminal in the `src` folder and run:
375+
- To install the requirement for backend -
376+
Open a terminal in the `src/backend` folder and run:
377377
```bash
378-
pip install -r requirements.txt
378+
pip install uv
379+
uv sync
379380
```
380381
381382
9. **Build the frontend (important):**
382383
384+
- To install the requirement for frontend -
385+
Open a terminal in the `src/frontend` folder and run:
386+
```bash
387+
pip install -r requirements.txt
388+
```
389+
383390
- Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.
384391
385392
From the `src/frontend` directory, run:
@@ -391,7 +398,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
391398
392399
10. **Run the application:**
393400
394-
- From the src/backend directory:
401+
- From the `src/backend` directory activate the virtual environment created through step 8 and Run:
395402
396403
```bash
397404
python app_kernel.py
@@ -403,8 +410,14 @@ python app_kernel.py
403410
python frontend_server.py
404411
```
405412
406-
10. Open a browser and navigate to `http://localhost:3000`
407-
11. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
413+
or Run
414+
415+
```bash
416+
npm run dev
417+
```
418+
419+
11. Open a browser and navigate to `http://localhost:3000`
420+
12. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
408421
409422
## Debugging the solution locally
410423

0 commit comments

Comments
 (0)