💡📊A prototype data dashboard for any FHIR server. Spin this up in front of your server so people can get a quick visual understanding of what's in this server.
The NCPI FHIR Dashboard app has been deployed into the three standard environments within the NCPI AWS account: Dev, QA, Prd.
Each dashboard deployment points at the NCPI FHIR server that has been deployed in the same environment (e.g. the dashboard deployed in the Dev environment points at the FHIR server deployed in the Dev environment)
The endpoints for these are:
https://ncpi-api-fhir-service.kidsfirstdrc.org/dashboard
https://ncpi-api-fhir-service-qa.kidsfirstdrc.org/dashboard
https://ncpi-api-fhir-service-dev.kidsfirstdrc.org/dashboard
In order to use the dashboard to browse data in NCPI servers you will need to:
- Request access to the server
- Authenticate with your Google account
Please follow the instructions on the NCPI FHIR Server README.
If you want to run the dashboard app and don't want to install dependencies directly on your machine, you can spin up the Dockerized dashboard app:
docker-compose up -dThis will launch an NGINX container serving your app at http://localhost:3000
By default the app points to a local FHIR server at http://localhost:8000.
If you want to change the FHIR server behind the app, you can set the environment
variables (see FHIR APIs) in your docker-compose.yml file.
If you are developing, you will need to setup your development
environment on your machine. This application utilizes create-react-app.
To run it, install the dependencies and start the server on your machine:
npm install
npm start
This will open up the application at localhost:3000.
More on create-react-app here.
If you want to change the FHIR server behind the app, you can set the environment
variables (see FHIR APIs) in your shell environment or a .env
file.
Creating a data dashboard over the FHIR API standard means that a user potentially has the ability to search over datasets from different FHIR servers.
This application can be launched over any FHIR server. To use a specific FHIR
server, set the following environment variables
(also found at /src/.env.example) in your shell environment if running
natively or in your Docker compose file if running via Docker:
REACT_APP_FHIR_API: The url at which the FHIR server is located
REACT_APP_FHIR_API_NAME: The display name of the FHIR server
REACT_APP_FHIR_API_AUTH_TYPE: The two options for this are NO_AUTH or BASIC_AUTH
Servers are configurable and more can be added after startup.
The dashboard uses Cypress and the local development server to run frontend tests. To open Cypress, use the command:
npm run cypress:open
This will pull up an interactive window for running tests. You must also be running the dashboard locally at http://localhost:3000 to run the tests. Click on any of the tests listed to execute them.