From 5585a05b85cb750ec794e98604c4fbdefd270dad Mon Sep 17 00:00:00 2001 From: sua yoo Date: Wed, 11 Jun 2025 13:18:16 -0700 Subject: [PATCH 1/2] update readme --- frontend/README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/frontend/README.md b/frontend/README.md index b9f91c303e..33f2244e45 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1 +1,19 @@ -[Development guide](../docs/develop/frontend-dev.md) +# Browsertrix Frontend + +This directory contains the following components: + +## Docs (`/docs`) + +Documentation for running, developing, and writing docs: +- Hosted: [docs.browsertrix.com/develop/docs](https://docs.browsertrix.com/develop/docs) +- Local: [develop/docs.md](./docs/docs/develop/docs.md) + +## User Interface (`/src`) + +Documentation for developing the user interface: +- Hosted: [docs.browsertrix.com/develop/frontend-dev](https://docs.browsertrix.com/develop/frontend-dev) +- Local: [develop/frontend-dev.md](./docs/docs/develop/frontend-dev.md) + +## Configuration + +Config files for the frontend Docker build and nginx routing can also be found in this directory. From 52ebe8fd796c6f2d116e8dc06c404528a46d573c Mon Sep 17 00:00:00 2001 From: sua yoo Date: Wed, 11 Jun 2025 13:29:37 -0700 Subject: [PATCH 2/2] update local dev setup --- frontend/docs/docs/develop/local-dev-setup.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/frontend/docs/docs/develop/local-dev-setup.md b/frontend/docs/docs/develop/local-dev-setup.md index dd0def5963..2077d7241c 100644 --- a/frontend/docs/docs/develop/local-dev-setup.md +++ b/frontend/docs/docs/develop/local-dev-setup.md @@ -130,6 +130,5 @@ After making any changes to backend code (in `./backend`) or frontend code (in ` Changes to settings in `./chart/local.yaml` can be deployed with `helm upgrade ...` directly. -## Deploying Frontend Only - -If you are just making changes to the frontend, you can also [deploy the frontend separately](frontend-dev.md) using a dev server for quicker iteration. +??? Info "Alternative method for developing the frontend" + If you are not writing backend code or otherwise making changes to the backend, you can run the frontend outside of Docker to quickly iterate on the user interface. See [UI Development](./frontend-dev.md) for instructions on how to develop the frontend using Node.js tools.