Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 4.81 KB

DeploymentGuide.md

File metadata and controls

87 lines (60 loc) · 4.81 KB
Raw

Requirements

Before you deploy, you must have the following accounts:

You must also have the following installed on your device:

The application is configured to launch from an EHR. If you do not have access to one, this simulates an EHR and can be used to test the app.

Clone The Repository

First, clone the GitHub repository onto your machine. To do this:

  1. Create a folder on your computer to contain the project code.
  2. For an Apple computer, open Terminal. If on a Windows machine, open Command Prompt or Windows Terminal. Enter into the folder you made using the command cd path/to/folder. To find the path to a folder on a Mac, right click on the folder and press Get Info, then select the whole text found under Where: and copy with ⌘C. On Windows (not WSL), enter into the folder on File Explorer and click on the path box (located to the left of the search bar), then copy the whole text that shows up.
  3. Clone the github repository by entering the following:
git clone https://github.com/UBC-CIC/basics-for-health.git

The code should now be in the folder you created. Navigate into the folder containing the Amplify project by running the command:

cd basics-for-health

Deployment

Before deploying the Amplify project we need to create an IAM Role that will give us the permissions needed to implement this solution. Run the following line of code:

aws cloudformation deploy --template-file cfn-amplifyRole.yaml --stack-name amplifyconsole-basics4health-backend-role --capabilities CAPABILITY_NAMED_IAM

If you have multiple AWS Profiles, use the one with sufficient admin permissions by appending the following text to the end of the command, replacing the profile name with the profile you would like to use for the solution.

--profile [PROFILE NAME]

This step creates an IAM role called amplifyconsole-basics4health-backend-role that will be used on the next step.

The Deploy to Amplify Console button will take you to your AWS console to deploy the solution. Make sure you are logged into your AWS account.

Deploy to Amplify Console

  1. On the AWS console, select your region and click Connect to GitHub. alt text

  2. Authorize AWS Amplify with your GitHub account (if required). alt text

  3. Select the amplifyconsole-basics4health-backend-role we made previously for the deployment role, and then press Save and Deploy alt text

  4. The deployment will take a few minutes. Wait until the status of Verify is green alt text

  5. On the left side menu, click on Rewrites and redirects and click the Edit button. Click and replace the first rule's source address (or add a rule if there is none) to </^((?!\.(css|gif|ico|jpg|js|png|txt|svg|woff|ttf)$).)*$/>. Replace the target address to /index.html, and replace the type to 200 (Rewrite). Refer to AWS's Page on Single Page Apps for further information on why that was necessary.

    It should look like this once you are done: alt text

  6. On the left side menu, click on Environment variables and then the Manage variables button. Add the following and save the change. If you are using the demo EHR, the endpoint is https://launch.smarthealthit.org/v/r4/fhir

    Variable: REACT_APP_EHR_ENDPOINT    Value: [Your FHIR endpoint]

    alt text

The app is now deployed!

The next step is to register the application with your EHR. Doing so will provide a unique Client ID associated with the app, along with a Client Secret. If you are using the demo EHR, any string for the client ID and secret will work as its not validated on the test server. Add the following environment variables to Amplify:

Variable: REACT_APP_EHR_CLIENT_ID	Value: [Your Client ID]
Variable: REACT_APP_EHR_CLIENT_SECRET	Value: [Your Client Secret]

If you wish to make changes and further contribute to this project, install the required packages and dependencies with the following command:

npm install