docs: Clarify hosted vs. self-deployment requirements (#2082 )

Updates docs to clarify difference between self-hosting and hosted
subscription.

---------

Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>

2024-09-18 13:43:09 -07:00

1.7 KiB

Raw Blame History

hide

toc

Developing Browsertrix

Local Development

Get the latest Browsertrix source using git:

git clone https://github.com/webrecorder/browsertrix.git

To develop Browsertrix, the system must first be deployed locally in a Kubernetes cluster. The deployment can then be further customized for local development.

Source Code

Browsertrix consists of a Python-based backend and TypeScript-based frontend.

Backend

The backend is an API-only system, using the FastAPI framework. Latest API docs can be viewed in the browser by adding /api/redoc to the URL of a running cluster (ex: http://localhost:30870/api/redoc when running locally on port 30870.)

At this time, the backend must be deployed in the Kubernetes cluster.

Frontend

The frontend UI is implemented in TypeScript, using the Lit framework and Shoelace component library.

The static build of the frontend is bundled with nginx, but the frontend can be deployed locally in dev mode against an existing backend.

See Developing the Frontend UI for more details.

Contributing

Browsertrix is planned and developed on GitHub: https://github.com/webrecorder/browsertrix. We welcome pull requests that contribute towards fixing bugs and feature enhancements.

Check out our project board to see current and upcoming features that the Webrecorder team is working on.

1.7 KiB Raw Blame History