Skip to content

fix design review script #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 17, 2024
Merged

fix design review script #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb66be6
fix design review script pointers
fzhao99 Oct 17, 2024
54d38cb
one more
fzhao99 Oct 17, 2024
91a8f60
stuff
fzhao99 Oct 17, 2024
235cd57
Merge branch 'main' into bob/fix-design-review-script
fzhao99 Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions query-connector/design-review/README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# 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

In order to use this script a copy must be downloaded onto your computer from GitHub . To do this follow these instructions.

1. Open the Terminal application.
2. Copy and paste `curl https://raw.githubusercontent.com/CDCgov/phdi/main/containers/tefca-viewer/design-review/design-review.sh -O` into the Terminal prompt and press enter. This command uses the wget program to download a copy the `design-review.sh` file from this directory to the root level of your user directory e.g. `Users/johndoe`.
2. Copy and paste `curl https://raw.githubusercontent.com/CDCgov/dibbs-query-connector/main/query-connector/design-review/design-review.sh -O` into the Terminal prompt and press enter. This command uses the wget program to download a copy the `design-review.sh` file from this directory to the root level of your user directory e.g. `Users/johndoe`.
3. Copy and paste `chmod +x design-review.sh` into Terminal and press enter. This command assigns executable permissions to `design-review.sh` allowing it to be run.


## 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 <MY-BRANCH>` into the Terminal prompt.
4. Replace `<MY-BRANCH>` 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 `<MY-BRANCH>` 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.
6 changes: 3 additions & 3 deletions query-connector/design-review/design-review.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ if ! command_exists docker-compose; then
fi

# Clone the repository if it doesn't exist, otherwise pull the latest changes
REPO_URL="https://github.com/CDCgov/phdi.git"
REPO_DIR="phdi"
REPO_URL="https://github.com/CDCgov/dibbs-query-connector.git"
REPO_DIR="dibbs-query-connector"

if [ ! -d "$REPO_DIR" ]; then
git clone $REPO_URL
Expand All @@ -56,7 +56,7 @@ else
git pull
fi

cd ./containers/tefca-viewer
cd ./query-connector

# Checkout the specified branch
git checkout $BRANCH_NAME
Expand Down