From 4638e624bf87da2f52f35c45e4106ad3217b072b Mon Sep 17 00:00:00 2001 From: XianBW <36835909+XianBW@users.noreply.github.com> Date: Fri, 9 Aug 2024 14:37:22 +0800 Subject: [PATCH] docs: add start app command in readme (#196) add start app command in readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3ebd76df..408d5c82 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,10 @@ You can try our demo by running the following command: - The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.) - please refer to [Configuration](docs/build/html/installation.html#azure-openai) for the detailed explanation of the `.env` ### 🚀 Run the Application +- Start streamlit web app to show log traces: + ```sh + streamlit run rdagent/log/ui/app.py --server.port 8080 -- --log_dir + ``` The [🎥demo](https://rdagent.azurewebsites.net) is implemented by the following commands: @@ -102,10 +106,10 @@ The [🎥demo](https://rdagent.azurewebsites.net) is implemented by the followin ### 🚀 Monitor the Application -You can serve our demo app to monitor the RD loop by running the following command: -```sh -TODO: run the front-page demo. -``` +- You can serve our demo app to monitor the RD loop by running the following command: + ```sh + streamlit run rdagent/log/ui/app.py --server.port 8080 -- --log_dir + ``` # Scenarios