a8f4f8cfc3
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>
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
---
|
|
hide:
|
|
- toc
|
|
---
|
|
|
|
# Developing Browsertrix
|
|
|
|
## Local Development
|
|
|
|
Get the latest Browsertrix source using git:
|
|
|
|
```sh
|
|
git clone https://github.com/webrecorder/browsertrix.git
|
|
```
|
|
|
|
To develop Browsertrix, the system must [first be deployed locally](../deploy/local.md) in a Kubernetes cluster. The deployment can then be [further customized for local development](./local-dev-setup.md).
|
|
|
|
## 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.
|
|
|
|
<!-- *TODO Add additional info here* -->
|
|
|
|
### Frontend
|
|
|
|
The frontend UI is implemented in TypeScript, using the [Lit](https://lit.dev/) framework and [Shoelace](https://shoelace.style/) 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](frontend-dev.md) for more details.
|
|
|
|
<!-- *TODO Add additional info here* -->
|
|
|
|
## Contributing
|
|
|
|
Browsertrix is planned and developed on GitHub: <https://github.com/webrecorder/browsertrix>. We welcome pull requests that contribute towards [fixing bugs](https://github.com/webrecorder/browsertrix/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and feature enhancements.
|
|
|
|
Check out our [project board](https://github.com/orgs/webrecorder/projects/9/views/1) to see current and upcoming features that the Webrecorder team is working on.
|