tea/browsertrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
652856e74c
browsertrix/docs/develop/index.md
Henry Wilkinson 45c9a91c9e
Docs: Improve relative links (#1476) 
### Changes

- Fixes one broken link (["Ansible Playbooks"
here](https://docs.browsertrix.cloud/deploy/remote/))
- Formats relative links better to conform with [mkdocs 1.5 link
validation
improvements](https://www.mkdocs.org/about/release-notes/#expanded-validation-of-links)
2024-02-07 11:33:57 -08:00

985 B
Raw Blame History

hide
toc

Developing Browsertrix Cloud

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

To develop Browsertrix Cloud, the system must first be deployed locally in a Kubernetes cluster.

The deployment can then be further customized for local development.

Backend

The backend is an API-only system, using the FastAPI framework. The latest API reference is available under ./api of a running cluster.

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.