Enable Burr UI to be added to existing FastAPI app#671
Merged
skrawcz merged 4 commits intoapache:mainfrom Mar 22, 2026
Merged
Conversation
skrawcz
reviewed
Mar 12, 2026
skrawcz
reviewed
Mar 12, 2026
Contributor
Author
|
@skrawcz,Thanks for the feedback! I've updated the PR to: • expose the Let me know if any further adjustments are needed. |
… UI into existing FastAPI apps
Refactor run.py to use a factory pattern (create_burr_ui_app) so all routes are registered on the sub-app instance, not at module level. Add mount_burr_ui() helper for embedding the Burr UI into an existing FastAPI application. When mounted at a sub-path (e.g. /burr), the server rewrites CRA's hardcoded absolute paths in index.html and injects window.__BURR_BASE_PATH__ so the React app can prefix all API calls and client-side routes at runtime. React-side changes: - OpenAPI.ts reads __BURR_BASE_PATH__ for API client BASE - App.tsx uses it as Router basename - appcontainer.tsx prefixes logo image paths - StreamingChatbot.tsx prefixes direct fetch calls
skrawcz
force-pushed
the
feature/burr-ui-mount
branch
from
9f8261a to
655e923
Compare
Contributor
|
@Smitaambiger with changes like these you really need to run things locally and verify that things work. Please do that next time and provide screenshots of things working. I have fixed up the issues that I found. |
skrawcz
approved these changes
Mar 21, 2026
- Add Window.__BURR_BASE_PATH__ type declaration to avoid no-explicit-any - Apply prettier formatting to TS files - Apply black formatting to test_local_tracking_client.py
Contributor
|
Otherwise thanks for getting this started @Smitaambiger ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a reusable FastAPI factory and helper function to allow the Burr UI
to be mounted inside an existing FastAPI application.
Changes:
create_burr_ui_app()factory to construct the Burr UI FastAPI app.mount_burr_ui(parent_app, path="/burr")helper to mount the UI as a sub-application.app = create_burr_ui_app().This enables users to run Burr tracking UI alongside their own FastAPI services
in the same application.
Closes #503