Skip to content

Commit 9e20617

Browse files
author
sd109
committed
Add tilt development section to readme
1 parent 1d55b4a commit 9e20617

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,17 @@ The Helm chart consists of the following components:
5757
- A frontend web-app built using [Gradio](https://www.gradio.app) and [LangChain](https://www.langchain.com). The web app source code can be found in `chart/web-app` and gets written to a ConfigMap during the chart build and is then mounted into the UI pod and executed as the entry point for the UI docker image (built from `images/ui-base/Dockerfile`).
5858

5959
- A [stakater/Reloader](https://github.com/stakater/Reloader) instance which monitors the web-app ConfigMap for changes and restarts the frontend when the app code changes (i.e. whenever the Helm values are updated).
60+
61+
## Development
62+
63+
The GitHub repository includes a [tilt](https://tilt.dev) file for easier development. After installing tilt locally, simply run `tilt up` from the repo root to get started with development. This will trigger the following:
64+
65+
- Install the backend API components of the Helm chart on the remote k8s cluster specified by your current k8s context.
66+
67+
- Create a port-forward from the remote cluster to `localhost:8080`
68+
69+
- Create a local `tilt-dev-venv` in the repo root containing the required Python dependencies to run the frontend web app locally.
70+
71+
- Launch the frontend web app locally on `127.0.0.1:7860`, configured to use `localhost:8080` as the backend API
72+
73+
- Watch all components and only reload the minimal set of components needed when a file in the repo changes (e.g. modifying `chart/web-app/app.py` will restart the local web app instance only)

0 commit comments

Comments
 (0)