Skip to content

github-pages-deployment.md

Latest commit

 

History

History
94 lines (60 loc) · 2.15 KB

github-pages-deployment.md

File metadata and controls

94 lines (60 loc) · 2.15 KB
Raw

GitHub Pages Deployment

Goal

This repository is already structured as a static site, so it can be deployed to GitHub Pages without adding a build tool.

Recommended Deployment Mode

Use GitHub Pages with the repository root as the publishing source.

Recommended if the repository is named something like:

  • hbti-prototype
  • hbti-health-biomarker-type-indicator

Files That Matter

The current deployable entry point is:

  • index.html

Supporting files:

  • styles.css
  • app.js
  • docs/assets/*.svg

Because the project uses relative paths, it works well as a simple static deployment.

Deployment Steps

  1. Push the repository to GitHub.
  2. Open repository Settings.
  3. Open Pages.
  4. Under Build and deployment, choose:
    • Source: Deploy from a branch
    • Branch: main
    • Folder: / (root)
  5. Save.
  6. Wait for GitHub Pages to publish the site.

Recommended Repository Settings

About section

Set:

  • Description: Exploratory metabolic-typing prototype for weight-management scenarios
  • Website: your GitHub Pages URL
  • Topics: digital-health, health-informatics, questionnaire-design, frontend, research-prototype

Social Preview

Recommended preview image:

  • docs/assets/hbti-cover.svg

If GitHub requires a raster upload for social preview, export that SVG as PNG and upload it manually through repository settings.

Suggested Public Positioning

If you publish this repository, the safest and strongest framing is:

A research-backed product prototype for metabolic typing in weight-management scenarios.

Do not describe it publicly as:

  • a diagnostic tool
  • a clinically validated assessment
  • a medical recommendation engine

Optional Improvements Later

If you want a stronger public-facing site later, consider:

  1. Adding a custom repository name focused on HBTI
  2. Exporting PNG preview images alongside SVG
  3. Adding bilingual landing-page copy
  4. Adding a dedicated /demo and /research split

What You Do Not Need Right Now

For this stage, you do not need:

  • React
  • Vite
  • npm
  • a backend
  • analytics

The current static architecture is enough for GitHub portfolio presentation.