From 91a8f60915c3e39d47c1849f498dbc4e60a079cc Mon Sep 17 00:00:00 2001 From: Bob Zhao Date: Thu, 17 Oct 2024 12:01:14 -0400 Subject: [PATCH] stuff --- query-connector/design-review/README.MD | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/query-connector/design-review/README.MD b/query-connector/design-review/README.MD index 44be6b7fc..f372baa1d 100644 --- a/query-connector/design-review/README.MD +++ b/query-connector/design-review/README.MD @@ -1,6 +1,6 @@ # Design Review Script -A bash script intended to allow designers and members of the team to easily spin up an instance of the TEFCA Viewer on their local machines for UI/UX review. Currently only MacOS is supported. +A bash script intended to allow designers and members of the team to easily spin up an instance of the Query Connector on their local machines for UI/UX review. Currently only MacOS is supported. ## Initial Setup @@ -12,11 +12,11 @@ In order to use this script a copy must be downloaded onto your computer from Gi ## Usage -Follow these steps to run script and spin up a local instance of the TEFCA Viewer. +Follow these steps to run script and spin up a local instance of the Query Connector. 1. Ensure you have completed the initial setup instructions. 2. Open the Terminal application. 3. Copy and paste `./design-review.sh ` into the Terminal prompt. -4. Replace `` with the name of the GitHub branch you would like to conduct a review on. For example, `./design-review.sh main` will spin up an instance of the TEFCA Viewer based on the current state of the `main` branch of repository. -5. Press enter. The script will now ensure that all required dependencies are installed on your machine, build and run the TEFCA Viewer, and finally navigate to the landing page in your system's default browser. Please note that because certain dependencies may need to be installed the script make take a few minutes the first time it is run on a machine. Additionally, depending on what needs to be installed you may be prompted at points during installation of dependencies to provide a password or click through some installation screens. -6. When you are done with your review to shut the TEFCA Viewer down return to Terminal and press enter. +4. Replace `` with the name of the GitHub branch you would like to conduct a review on. For example, `./design-review.sh main` will spin up an instance of the Query Connector based on the current state of the `main` branch of repository. +5. Press enter. The script will now ensure that all required dependencies are installed on your machine, build and run the Query Connector, and finally navigate to the landing page in your system's default browser. Please note that because certain dependencies may need to be installed the script make take a few minutes the first time it is run on a machine. Additionally, depending on what needs to be installed you may be prompted at points during installation of dependencies to provide a password or click through some installation screens. +6. When you are done with your review to shut the Query Connector down return to Terminal and press enter.