Web Frontend for the ENGAGE-HF project.
The frontend allows providers and study coordinators to manage patients, enter medications, lab values, allergies, appointments and manage the ENGAGE-HF study.
The ENGAGE-HF Web Frontend repository contains a React application built with TypeScript, Vite and Firebase. It provides automated GitHub Actions, setups for code linting, testing & test coverage reports, docker deployments, a docker compose setup.
This project uses Node.js v22. Install Node.js, e.g. using nvm, homebrew (for macOS) or the official Node.js installer .
In order to use Web Frontend, you need to use actual Firebase environment or Emulator with seeded data. For developing locally, it's best to use the Emulator.
-
Clone
https://github.com/StanfordBDHG/ENGAGE-HF-Firebaserepository -
In the root of ENGAGE-HF-Firebase run:
npm run prepare && npm run serve:seededRepeat step 2 each time files have changed.
Refer to ENGAGE-HF-Firebase repository for more details.
- Install all dependencies
npm install- Setup environment variables
Refer .env.example file for environment variables documentation. Copy .env.example to .env.local and adjust if necessary.
- Start the Vite Application
npm run devOpen http://localhost:5173 with your browser to see the result.
- Install Docker on your machine.
- Build the image and run the docker compose setup:
docker compose -f docker-compose-development.yml up.
You can view the images you create with docker images.
Open http://localhost with your browser to see the result. You can visit http://localhost:8080 to see the reverse proxy setup before the main application.
The docker-compose.yml setup contains a production-ready setup using a reverse proxy.
Every version of the application on the main branch is automatically packaged into docker images using the main tag. Every release is also published using the latest and respective version tags.
This repository contains all necessary files to deploy the web frontend to Google Cloud Firebase.
...
This project is licensed under the MIT License. See Licenses for more information.
This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. See CONTRIBUTORS.md for a full list of all contributors.
