Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions docs/DeploymentGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,16 +370,23 @@ The files for the dev container are located in `/.devcontainer/` folder.

- If you are using `venv`, create and activate your virtual environment for both the frontend and backend folders.

8. **Install requirements - frontend:**
8. **Install requirements - Backend:**

- In each of the frontend and backend folders -
Open a terminal in the `src` folder and run:
- To install the requirement for backend -
Open a terminal in the `src/backend` folder and run:
```bash
pip install -r requirements.txt
pip install uv
uv sync
```

9. **Build the frontend (important):**

- To install the requirement for frontend -
Open a terminal in the `src/frontend` folder and run:
```bash
pip install -r requirements.txt
```

- Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.

From the `src/frontend` directory, run:
Expand All @@ -391,7 +398,7 @@ The files for the dev container are located in `/.devcontainer/` folder.

10. **Run the application:**

- From the src/backend directory:
- From the `src/backend` directory activate the virtual environment created through step 8 and Run:

```bash
python app_kernel.py
Expand All @@ -403,8 +410,14 @@ python app_kernel.py
python frontend_server.py
```

10. Open a browser and navigate to `http://localhost:3000`
11. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
or Run

```bash
npm run dev
```

11. Open a browser and navigate to `http://localhost:3000`
12. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`

## Debugging the solution locally

Expand Down
Loading