tea/browsertrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14b349443f
browsertrix/docs/dev/index.md
Henry Wilkinson a74d88dcda
mkdocs setup (deploy, dev, user-guide) (#375) 
* Initial docs move
* Setup mkdocs
* Adds instructions for building docs
* add new deployment docs, local and prod
* set up three sections: deployment, dev and user guide
* remove old deployment docs
* ci: mkdocs gh-pages publish

Co-authored-by: sua yoo <sua@suayoo.com>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2022-12-05 16:41:37 -08:00

633 B
Raw Blame History

Developer Docs

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

Backend

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

TODO Add additional info here

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 Running Frontend for more details.

TODO Add additional info here