Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stanfordbdhg/engage-hf-web-frontend
Web Frontend of the ENGAGE-HF Project
https://github.com/stanfordbdhg/engage-hf-web-frontend
Last synced: 5 days ago
JSON representation
Web Frontend of the ENGAGE-HF Project
- Host: GitHub
- URL: https://github.com/stanfordbdhg/engage-hf-web-frontend
- Owner: StanfordBDHG
- License: mit
- Created: 2024-05-29T22:17:09.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-04T20:29:44.000Z (8 days ago)
- Last Synced: 2024-11-04T21:26:12.854Z (8 days ago)
- Language: TypeScript
- Size: 1.23 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Stanford Biodesign Digital Health ENGAGE-HF Web Frontend
[](https://github.com/StanfordBDHG/ENGAGE-HF-Web-Frontend/actions/workflows/build-and-test.yml)
[](https://github.com/StanfordBDHG/ENGAGE-HF-Web-Frontend/actions/workflows/deployment.yml)
[](https://codecov.io/gh/StanfordBDHG/ENGAGE-HF-Web-Frontend)
## How To Use ENGAGE-HF Web Frontend
The ENGAGE-HF Web Frontend repository contains a Next.js project providing automated GitHub Actions and setups for code linting, testing & test coverage reports, docker deployments, a docker compose setup, local packages for modular deployment.
## Getting Started
You can run the project using the following command. You will need to install Node.js and npm, e.g., using [homebrew (recommended for macOS)](https://formulae.brew.sh/formula/node) or the official [Node.js installer](https://nodejs.org/en/download).
1. Install All Dependencies
```bash
npm install
```
2. Setup Firebase Environment Values
Create an `.env.local` file or inject the following environment variables required for the Google Firebase Setup:
```
VITE_PUBLIC_FIREBASE_API_KEY=
VITE_PUBLIC_FIREBASE_AUTH_DOMAIN=
VITE_PUBLIC_FIREBASE_PROJECT_ID=
VITE_PUBLIC_FIREBASE_STORAGE_BUCKET=
VITE_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
VITE_PUBLIC_FIREBASE_APP_ID=
VITE_PUBLIC_EMULATOR=
VITE_PUBLIC_EMAIL_PASSWORD_SIGN_IN=""
```
3. Start the Vite Application
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can edit the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Docker
1. [Install Docker](https://docs.docker.com/get-docker/) on your machine.
2. 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](http://localhost) with your browser to see the result. You can visit [http://localhost:8080](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.
## Deployment
This repository contains all necessary files to deploy the web frontend to Google Cloud Firebase ([Stanford mHealth Platform](https://med.stanford.edu/mhealth.html)).
### Deployment Configuration
...
## License
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordBDHG/ENGAGE-HF-Web-Frontend/tree/main/LICENSES) for more information.
## Contributors
This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University.
See [CONTRIBUTORS.md](https://github.com/StanfordBDHG/ENGAGE-HF-Web-Frontend/tree/main/CONTRIBUTORS.md) for a full list of all contributors.
