Merge pull request #64 from mcode/rems-556-connectathon-docs

Update docs for Jan 2024 Connectathon

.env

@@ -1,20 +1,14 @@
-# Development URLS
-
-REACT_APP_REMS_ADMIN_SERVER_BASE = http://localhost:8090
-REACT_APP_REMS_HOOKS_PATH = /cds-services/rems-
-REACT_APP_PHARMACY_SERVER_BASE = http://localhost:5051
-REACT_APP_ETASU_STATUS_ENABLED = true
-REACT_APP_PHARMACY_STATUS_ENABLED = true
-REACT_APP_SEND_RX_ENABLED = true
-REACT_APP_SEND_FHIR_AUTH_ENABLED = false
+BROWSER=none
+GENERATE_SOURCEMAP=false
 PORT=4040
+REACT_APP_CLIENT_SCOPES = launch openid profile user/Patient.read patient/Patient.read user/Practitioner.read
 REACT_APP_DEFAULT_CLIENT_ID = app-login
 REACT_APP_DEFAULT_ISS = http://localhost:8080/test-ehr/r4
-REACT_APP_CLIENT_SCOPES = launch openid profile user/Patient.read patient/Patient.read user/Practitioner.read
 REACT_APP_DEVELOPER_MODE = true
-GENERATE_SOURCEMAP=false
-BROWSER=none
-
-# To Override start command:
-# REACT_APP_REMS_HOOKS_PATH=http://example.com PORT=6000 npm start
-# Note that .env values can only be accessed by react app starting with 'REACT_APP_'
+REACT_APP_ETASU_STATUS_ENABLED = true
+REACT_APP_PHARMACY_SERVER_BASE = http://localhost:5051
+REACT_APP_PHARMACY_STATUS_ENABLED = true
+REACT_APP_REMS_ADMIN_SERVER_BASE = http://localhost:8090
+REACT_APP_REMS_HOOKS_PATH = /cds-services/rems-
+REACT_APP_SEND_FHIR_AUTH_ENABLED = false
+REACT_APP_SEND_RX_ENABLED = true

README.md

@@ -1,10 +1,11 @@
 # Getting Started with REMS SMART on FHIR
 
-The REMS SMART on FHIR application can be launched from an EHR that does not support CDS Hooks. The application will interact with the REMS Administrator using CDS Hooks on behalf of the EHR, allowing the provider to complete the normal REMS workflow. 
+The REMS SMART on FHIR application can be launched from an EHR that does not support CDS Hooks. The application will interact with the REMS Administrator using CDS Hooks on behalf of the EHR, allowing the provider to complete the normal REMS workflow.
 
 This application must be launched by an EHR or SMART sandbox imitating an EHR.
 
 ## Initialization
+
 After cloning the repository, the submodules must be initialized. To do this you can run:
 
 ### `git submodule update --init`
@@ -22,30 +23,35 @@ The page will reload if you make edits.\
 You will also see any lint errors in the console.
 
 ### How To Override Defaults
-The .env file contains the default URI paths, these can be overwritten from the start command as follows:
- `REACT_APP_REMS_HOOKS_PATH=http://example.com PORT=6000 npm start`
-
-Following are a list of modifiable paths: 
-
-| URI Name      | Default |
-| ----------- | ----------- |
-| REACT_APP_REMS_ADMIN_SERVER_BASE       | `http://localhost:8090`  |
-| REACT_APP_REMS_HOOKS_PATH   | `/cds-services/rems-order-sign`        |
-| REACT_APP_PHARMACY_SERVER_BASE       | `http://localhost:5051`  |
-| REACT_APP_ETASU_STATUS_ENABLED       | `true`  |
-| REACT_APP_PHARMACY_STATUS_ENABLED       | `true`  |
-| REACT_APP_DEVELOPER_MODE        | `true`  |
-| REACT_APP_SEND_RX_ENABLED       | `true`  |
-| REACT_APP_SEND_FHIR_AUTH_ENABLED       | `false`  |
-| PORT   | `4040`|
-
- *Note that .env values can only be accessed by react app starting with `REACT_APP_`*
 
+The .env file contains the default URI paths, which can be overwritten from the start command as follows:
+a) `REACT_APP_LAUNCH_URL=http://example.com PORT=6000 npm start` or b) by specifying the environment variables and desired values in a `.env.local`.
+
+Following are a list of modifiable paths:
+
+| URI Name                          | Default                                                                               |
+| --------------------------------- | ------------------------------------------------------------------------------------- |
+| BROWSER                           | `none`                                                                                |
+| GENERATE_SOURCEMAP                | `false`                                                                               |
+| PORT                              | `4040`                                                                                |
+| REACT_APP_CLIENT_SCOPES           | `launch openid profile user/Patient.read patient/Patient.read user/Practitioner.read` |
+| REACT_APP_DEFAULT_CLIENT_ID       | `app-login`                                                                           |
+| REACT_APP_DEFAULT_ISS             | `http://localhost:8080/test-ehr/r4`                                                   |
+| REACT_APP_DEVELOPER_MODE          | `true`                                                                                |
+| REACT_APP_ETASU_STATUS_ENABLED    | `true`                                                                                |
+| REACT_APP_PHARMACY_SERVER_BASE    | `http://localhost:5051`                                                               |
+| REACT_APP_PHARMACY_STATUS_ENABLED | `true`                                                                                |
+| REACT_APP_REMS_ADMIN_SERVER_BASE  | `http://localhost:8090`                                                               |
+| REACT_APP_REMS_HOOKS_PATH         | `/cds-services/rems-`                                                                 |
+| REACT_APP_SEND_FHIR_AUTH_ENABLED  | `false`                                                                               |
+| REACT_APP_SEND_RX_ENABLED         | `true`                                                                                |
+
+_Note that .env values can only be accessed by the React app starting with `REACT_APP_`\_
 
 ### `npm test`
 
 Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+See the section about [running tests](https://create-react-app.dev/docs/running-tests/) for more information.
 
 ### `npm run build`
 
@@ -55,5 +61,4 @@ It correctly bundles React in production mode and optimizes the build for the be
 The build is minified and the filenames include the hashes.\
 Your app is ready to be deployed!
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
+See the section about [deployment](https://create-react-app.dev/docs/deployment/) for more information.