Data

Tools

Indexes

Applications

Experiments

Open Source Science

spezi-web-template-application

Web Dashboard Template Using the Spezi Web Ecosystem

https://github.com/stanfordspezi/spezi-web-template-application

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 (15.1%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Web Dashboard Template Using the Spezi Web Ecosystem

Basic Info
  • Host: GitHub
  • Owner: StanfordSpezi
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 1.84 MB
Statistics
  • Stars: 0
  • Watchers: 9
  • Forks: 1
  • Open Issues: 4
  • Releases: 0
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

Stanford Biodesign Digital Health Spezi Web Template Application Web Frontend

Build and Test codecov

Template repository for a web React application

Stack

The Spezi Web Template Application repository contains a React application built with TypeScript, Vite and Firebase. It provides automated GitHub Actions, setups for code linting, testing and test coverage reports, docker deployments, a docker compose setup. Uses Stanford Spezi Web kit.

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

To use Web Frontend, you need to use an actual Firebase environment or Emulator with seeded data. For developing locally, it's best to use the Emulator.

  1. Clone https://github.com/StanfordBDHG/ENGAGE-HF-Firebase repository

  2. In 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 the ENGAGE-HF-Firebase repository for more details.

Dashboard

  1. Install all dependencies

bash npm install

  1. Setup environment variables

Refer .env.example file for environment variables documentation. Copy .env.example to .env.local and adjust if necessary.

  1. Start the Vite Application

bash npm run dev

Open http://localhost:5173 with your browser to see the result.

Docker

  1. Install 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 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.

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.

Stanford Byers Center for Biodesign Logo Stanford Byers Center for Biodesign Logo

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff) 

#
# This source file is part of the Stanford Biodesign Digital Health Spezi Web Template Application open-source project
#
# SPDX-FileCopyrightText: 2025 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: 'Arkadiusz'
    given-names: 'Bachorski'
title: 'Spezi Web Template Application'
url: 'https://github.com/StanfordSpezi/spezi-web-template-application'

GitHub Events

Total
  • Create event: 8
  • Issues event: 4
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 16
  • Member event: 3
  • Push event: 9
  • Pull request review comment event: 8
  • Pull request review event: 11
  • Pull request event: 13
  • Fork event: 1
Last Year
  • Create event: 8
  • Issues event: 4
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 16
  • Member event: 3
  • Push event: 9
  • Pull request review comment event: 8
  • Pull request review event: 11
  • Pull request event: 13
  • Fork event: 1

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 4
  • Total Committers: 2
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.25
Past Year
  • Commits: 4
  • Committers: 2
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.25
Top Committers
Name Email Commits
Arkadiusz Bachorski 6****i 3
Paul Schmiedmayer P****r 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 7
  • Total pull requests: 9
  • Average time to close issues: 24 minutes
  • Average time to close pull requests: 2 months
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 1.43
  • Average comments per pull request: 1.44
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 7
  • Pull requests: 9
  • Average time to close issues: 24 minutes
  • Average time to close pull requests: 2 months
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 1.43
  • Average comments per pull request: 1.44
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
  • arkadiuszbachorski (4)
Pull Request Authors
  • dependabot[bot] (8)
  • arkadiuszbachorski (4)
  • NikolaiMadlener (2)
Top Labels
Issue Labels
enhancement (4)
Pull Request Labels
dependencies (8) enhancement (2) javascript (2)

Dependencies

.github/workflows/deployment.yml actions
  • actions/checkout v4 composite
.github/workflows/production.yml actions
.github/workflows/build-and-test.yml actions
.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/init v3 composite
.github/workflows/monthly-markdown-link-check.yml actions
Dockerfile docker
  • base latest build
  • node 18-alpine build
docker-compose-development.yml docker
  • stanfordbdgh/nextjstemplate dev
  • traefik v2.4
docker-compose.yml docker
  • ghcr.io/stanfordbdhg/nextjstemplate latest
  • traefik v2.4
package-lock.json npm
  • 694 dependencies
package.json npm
  • @testing-library/jest-dom ^6 development
  • @testing-library/react ^15 development
  • @total-typescript/ts-reset ^0.5.1 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