From 410a4c75b7d217683f9465d4328c681ae74cb94a Mon Sep 17 00:00:00 2001 From: Gold856 <117957790+Gold856@users.noreply.github.com> Date: Thu, 20 Mar 2025 18:08:17 -0400 Subject: [PATCH] Document UI hot reload option in dev docs (#1834) --- docs/source/docs/contributing/building-photon.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/docs/contributing/building-photon.md b/docs/source/docs/contributing/building-photon.md index fe0224a85..10da7f643 100644 --- a/docs/source/docs/contributing/building-photon.md +++ b/docs/source/docs/contributing/building-photon.md @@ -69,6 +69,16 @@ In the root directory: ``gradlew buildAndCopyUI`` ``` +### Using hot reload on the UI + +In the photon-client directory: + +```bash +npm run dev +``` + +This allows you to make UI changes quickly without having to spend time rebuilding the jar. Hot reload is enabled, so changes that you make and save are reflected in the UI immediately. Running this command will give you the URL for accessing the UI, which is on a different port than normal. You must use the printed URL to use hot reload. + ### Build and Run PhotonVision To compile and run the project, issue the following command in the root directory: