The purpose of this example app is to show how you can use the fdns-ms-object and fdns-ms-indexing services with a front-end interface built with fdns-ui-react and fdns-js-sdk. The use case for this example app is to view and index objects from the Datalake. You can also download data summaries via the fdns-ms-reporting and fdns-ms-storage services.
You will need to have the following installed before getting up and running locally:
- Docker, Installation guides
- Docker Compose, Installation guides
- Windows Users: This project uses
Make, please see Cygwin for running commands in this README
This project was bootstrapped with Create React App.
You can find the most recent version of the Create React App guide here.
This app uses the following FDNS libraries hosted on npm.
Run npm i to install dependencies.
To start the background processes necessary, run docker compose to spin up fdns-ms-indexing, fdns-ms-hl7-object, fdns-ms-storage, and fdns-ms-reporting, which are all needed to run this app:
docker-compose up -d
To start the app:
npm start
You should be able to visit http://localhost:3000/ to view the dashboard.
To stop running the docker background images:
docker-compose down
This app is able to run in a configuration where a OAuth 2.0 access token is needed before accessing the front-end such as with Foundation Services running with OAuth 2.0 enabled. You can pass the following environment variables to your Docker container:
SECURE_MODE=trueto run in the secure mode configurationAUTH_URL=https://authorization-server.com/oauth/authorizethe value for the authorization URL from your OAuth 2.0 provider
Your AUTH_URL should follow the general guidelines for a Single Page App.
The following is an example of what this URL might look like and how your redirect_uri should be formatted:
https://authorization-server.com/oauth/authorize
?client_id=REPLACE_WITH_CLIENT_ID
&response_type=code
&state=REPLACE_WITH_STATE
&redirect_uri=https%3A%2F%2Fexample-app.com%2Fauth
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
The source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.
The source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.
You should have received a copy of the Apache Software License along with this program. If not, see https://www.apache.org/licenses/LICENSE-2.0.html
The source code forked from other open source projects will inherit its license.
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Surveillance Platform Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/privacy.html.
Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.
All comments, messages, pull requests, and other submissions received through CDC including this GitHub page are subject to the Presidential Records Act and may be archived. Learn more at https://www.cdc.gov/other/privacy.html.
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.
Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.