0a1f5eff8e
* Add stylesheet & mkdocs features - Adds a custom stylesheet & brand colours - Adds Recursive as the code font - Adds repo info to the nav bar - Adds auto tracking ID links for deep linking to sections as users scroll the page - Index pages are now a part of their section as determined by their H1 - Removes mkdocs info from future footer * Reorganize content - Renames "Dev" to "Develop" for improved navigation labels - Adds links to tools the first time they're mentioned - Rewords part of the homepage - Hides section navigation on the homepage (now we don't have a blank section nav bar! - Adds some syntax highlighting - Removes some manual word wrapping — this was done very rarely / inconsistently * Rename "Developer Docs" index page - Better title for sidebar * Update docs.md - Adds links to tools - Adds future docs style guide section - Updates name and makes it an H1 - Replaces hyphens on the homepage with em dashes * deployment index page: changed title, removed non-k8s section, cleaned up intro * develop index page: changed title fixed typo on main page --------- Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
647 B
647 B
Developing Browsertrix Cloud
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