engage-hf-web-frontend
Web Frontend of the ENGAGE-HF Project
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords from Contributors
Repository
Web Frontend of the ENGAGE-HF Project
Basic Info
- Host: GitHub
- Owner: StanfordBDHG
- License: mit
- Language: TypeScript
- Default Branch: main
- Size: 2.03 MB
Statistics
- Stars: 1
- Watchers: 5
- Forks: 4
- Open Issues: 4
- Releases: 7
Metadata Files
README.md
Stanford Biodesign Digital Health ENGAGE-HF Web Frontend
Web Frontend for the ENGAGE-HF project.
Behavior
The frontend allows providers and study coordinators to manage patients, enter medications, lab values, allergies, appointments and manage the ENGAGE-HF study.
Stack
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.
Getting started
This project uses Node.js v22. Install Node.js, e.g. using nvm, homebrew (for macOS) or the official Node.js installer .
Backend
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-FirebaserepositoryIn the root of ENGAGE-HF-Firebase run:
bash
npm run prepare && npm run serve:seeded
Repeat step 2 each time files have changed.
Refer to ENGAGE-HF-Firebase repository for more details.
Dashboard
- Install all dependencies
bash
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
bash
npm run dev
Open http://localhost:5173 with your browser to see the result.
Docker
- 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.
Deployment
This repository contains all necessary files to deploy the web frontend to Google Cloud Firebase.
Deployment Configuration
...
License
This project is licensed under the MIT License. See Licenses for more information.
Contributors
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.
Owner
- Name: Stanford Biodesign Digital Health
- Login: StanfordBDHG
- Kind: organization
- Location: United States of America
- Twitter: StanfordBDHG
- Repositories: 18
- Profile: https://github.com/StanfordBDHG
Citation (CITATION.cff)
#
# This source file is part of the Stanford Biodesign Digital Health ENGAGE-HF open-source project
#
# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#
cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
authors:
- family-names: 'Schmiedmayer'
given-names: 'Paul'
orcid: 'https://orcid.org/0000-0002-8607-9148'
- family-names: 'Ravi'
given-names: 'Vishnu'
orcid: 'https://orcid.org/0000-0003-0359-1275'
- family-names: 'Arkadiusz'
given-names: 'Bachorski'
title: 'ENGAGE-HF Web Frontend'
url: 'https://github.com/StanfordBDHG/ENGAGE-HF-Web-Frontend'
GitHub Events
Total
- Create event: 65
- Release event: 7
- Issues event: 38
- Delete event: 54
- Member event: 1
- Issue comment event: 93
- Push event: 117
- Pull request review comment event: 17
- Pull request review event: 51
- Pull request event: 115
- Fork event: 2
Last Year
- Create event: 65
- Release event: 7
- Issues event: 38
- Delete event: 54
- Member event: 1
- Issue comment event: 93
- Push event: 117
- Pull request review comment event: 17
- Pull request review event: 51
- Pull request event: 115
- Fork event: 2
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Arkadiusz Bachorski | 6****i | 83 |
| dependabot[bot] | 4****] | 7 |
| Paul Schmiedmayer | P****r | 6 |
| Paul | p****t | 1 |
| Paul Goldschmidt | g****b@g****d | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 28
- Total pull requests: 155
- Average time to close issues: about 2 months
- Average time to close pull requests: 5 days
- Total issue authors: 6
- Total pull request authors: 5
- Average comments per issue: 0.61
- Average comments per pull request: 1.18
- Merged pull requests: 111
- Bot issues: 0
- Bot pull requests: 40
Past Year
- Issues: 15
- Pull requests: 134
- Average time to close issues: 13 days
- Average time to close pull requests: 5 days
- Issue authors: 6
- Pull request authors: 5
- Average comments per issue: 0.73
- Average comments per pull request: 1.15
- Merged pull requests: 95
- Bot issues: 0
- Bot pull requests: 34
Top Authors
Issue Authors
- arkadiuszbachorski (19)
- pauljohanneskraft (4)
- kylieo123 (3)
- PSchmiedmayer (2)
- dependabot[bot] (2)
- ats114 (1)
- PaulGoldschmidt (1)
Pull Request Authors
- arkadiuszbachorski (160)
- dependabot[bot] (54)
- PSchmiedmayer (7)
- pauljohanneskraft (3)
- PaulGoldschmidt (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v4 composite
- github/codeql-action/analyze v3 composite
- github/codeql-action/init v3 composite
- base latest build
- node 18-alpine build
- stanfordbdgh/engagehfwebfrontend dev
- traefik v2.4
- ghcr.io/stanfordbdhg/engagehfwebfrontend latest
- traefik v2.4
- 694 dependencies
- @testing-library/jest-dom ^6 development
- @testing-library/react ^15 development
- @types/jest ^29 development
- @types/node ^20 development
- @types/react ^18 development
- @types/react-dom ^18 development
- @typescript-eslint/eslint-plugin ^7 development
- @typescript-eslint/parser ^7 development
- autoprefixer ^10 development
- concurrently ^8 development
- eslint ^8 development
- eslint-config-next ^14 development
- eslint-config-prettier ^9 development
- eslint-plugin-import ^2 development
- eslint-plugin-prettier ^5 development
- jest ^29 development
- jest-environment-jsdom ^29 development
- postcss ^8 development
- prettier ^3 development
- tailwindcss ^3 development
- ts-jest ^29 development
- typedoc ^0.25 development
- typescript ^5 development
- @stanfordbdhg/example-package file:../packages/example-package
- next ^14
- prettier-plugin-tailwindcss ^0.5.14
- react ^18
- react-dom ^18
- sharp ^0.33