Skip to content

docs: Update frontend dev docs #2666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 12, 2025
Merged

docs: Update frontend dev docs #2666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5585a05
update readme
SuaYoo Jun 11, 2025
52ebe8f
update local dev setup
SuaYoo Jun 11, 2025
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
20 changes: 19 additions & 1 deletion frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 2 additions & 3 deletions frontend/docs/docs/develop/local-dev-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading