AugMed is a web application, built for the UNC-Chapel Hill DHEP Lab, that allows the lab to collect data from participants in a user-friendly way. The app is designed to be used on any devices, and it allows participants to answer questions about their judgements for cases with potential Colorectal Cancer (CRC). The app is built using React, and the backend API is built using Flask and Python.
Live Website: https://augmed1.dhep.org/.
Note
Backend Repository: DHEP Lab AugMed Backend.
Before you begin, ensure you have met the following requirements:
- You have a working installation of Node.js (version 14 or later).
- You have npm (Node Package Manager) installed, which comes with Node.js.
- You have access to the DHEP Lab's API and the necessary credentials to connect to it.
- You have a code editor installed (e.g., Visual Studio Code).
- You have a web browser installed (e.g., Chrome, Firefox).
- You have a tablet or device for testing the app, if applicable.
-
Clone the repository: Open your terminal and run the following command to clone the repository:
git clone <repository-url>
-
Navigate to the project directory:
cd AugMed-app -
Install dependencies:
Run the following command to install the required dependencies:
npm install
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
The app is deployed using AWS services. The deployment process involves the following steps:
- Build the app: Run
npm run buildto create a production build of the app. This is automatically done in the CI/CD pipeline (GitHub Actions). - Push the build to AWS S3: The build files are uploaded to an S3 bucket for hosting.
- Deploy the app using AWS ECS: The app is deployed to an ECS cluster using a Docker container.
- Configure the load balancer: An Application Load Balancer (ALB) is set up to route traffic to the ECS service.
- Set up DNS: The domain name is configured to point to the ALB.
- Monitor the deployment: The deployment is monitored to ensure that the app is running smoothly.
- Update the app: When updates are made to the app, the deployment process is repeated to push the changes to production.
It also uses Terraform to manage the infrastructure as code.
Tip
Visit the augmed-infra repository for more details on the infrastructure setup and deployment process.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Getting cases assigned: To get cases assigned, please contact the DHEP Lab team. Typically, cases are assigned to participants based on their availability and the lab's research needs.