From 68ba9653ef349483339336919d387d95695fd5d7 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 20 Feb 2024 21:03:26 +1100 Subject: [PATCH] Update devcontainer docs (#6527) - Closes https://github.com/inventree/InvenTree/issues/6392 --- docs/docs/develop/react-frontend.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/docs/develop/react-frontend.md b/docs/docs/develop/react-frontend.md index 227e12c842..ead305c912 100644 --- a/docs/docs/develop/react-frontend.md +++ b/docs/docs/develop/react-frontend.md @@ -39,6 +39,9 @@ This command does not run as a background daemon, and will occupy the window it' When the frontend server is running, it will be available on port 5173. i.e: https://localhost:5173/ +!!! note "Backend Server" + The InvenTree backend server must also be running, for the frontend interface to have something to connect to! To launch a backend server, use the `invoke server` command. + ### Debugging You can attach the vscode debugger to the frontend server to debug the frontend code. With the frontend server running, open the `Run and Debug` view in vscode and select `InvenTree Frontend - Vite` from the dropdown. Click the play button to start debugging. This will attach the debugger to the running vite server, and allow you to place breakpoints in the frontend code. @@ -66,3 +69,11 @@ to !!! tip "Make sure to not commit this change!" !!! warning "This change will require you to restart the frontend server for every change you make in the frontend code" + +### Caveats + +When running the frontend development server, some features may not work entirely as expected! Please take the time to understand the flow of data when running the frontend development server, and how it interacts with the backend server! + +#### SSO Login + +When logging into the frontend dev server via SSO, the redirect URL may not redirect correctly.