Initial commit

Author: nsitu

.github/workflows/main.yml

@@ -0,0 +1,84 @@
+# .github/workflows/deploy-pages.yml
+name: Deploy static content to Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # ---------- 1) Check if Pages is enabled ----------
+      - name: Detect GitHub Pages status
+        id: pages_status
+        run: |
+          set -e
+          http_status=$(curl -s -o /dev/null -w "%{http_code}" \
+            -H "Authorization: Bearer ${{ github.token }}" \
+            -H "Accept: application/vnd.github+json" \
+            https://api.github.com/repos/${{ github.repository }}/pages)
+
+          if [ "$http_status" = "200" ]; then
+            echo "✅ Pages already enabled."
+            echo "deploy=yes" >> "$GITHUB_OUTPUT"
+          else
+            echo "::notice ::GitHub Pages is not enabled for this repository yet."
+            echo "::notice ::Enable it under Settings → Pages (select **GitHub Actions** as the source) and rerun the workflow."
+            echo "deploy=no" >> "$GITHUB_OUTPUT"
+          fi
+
+      # ---------- 2) Stop early when Pages is disabled ----------
+      - name: Early‑exit (no deploy needed)
+        if: steps.pages_status.outputs.deploy == 'no'
+        run: echo "Skipping build & deploy because Pages is disabled."
+        # Workflow ends successfully here when deploy=no
+        continue-on-error: false
+
+      # ---------- 3) Normal build & deploy path ----------
+      - name: Set up Node
+        if: steps.pages_status.outputs.deploy == 'yes'
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: npm
+
+      - name: Install dependencies
+        if: steps.pages_status.outputs.deploy == 'yes'
+        run: npm ci
+
+      - name: Build
+        if: steps.pages_status.outputs.deploy == 'yes'
+        run: npm run build
+
+      - name: Setup Pages
+        if: steps.pages_status.outputs.deploy == 'yes'
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        if: steps.pages_status.outputs.deploy == 'yes'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+      - name: Deploy to GitHub Pages
+        if: steps.pages_status.outputs.deploy == 'yes'
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

README.md

@@ -0,0 +1,14 @@
+# github-pages-vite
+Template for using Vite with GitHub Pages
+
+## GitHub Action
+This template includes a GitHub Action workflow at `.github/workflows/main.yml`. The Action builds the Vite app to `/dest`. It then deploys the contents of `/dest` to production at `https://user.github.io/repository` 
+
+## Vite Config
+When deploying a repository to GitHub Pages, the repository name will by default become part of the URL path. (e.g. `https://user.github.io/repository` ) Vite has been configured in `vite.config.js` in order to dynamically understand this path based on a flag in the GitHub Actions build environment. During local development, Vite will assume a root of `/` but when building for produciton, it will instead use `/repository/` as the root.
+
+## How to Use
+- Make a new repository from this template. 
+- In the Rpository Settings, go to `Pages`
+- Under `Build and Deployment` change the `Source` to `GitHub Actions`
+- Now, when you push changes they will be auto deployed to `https://user.github.io/repository`

index.html

@@ -0,0 +1,27 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <link
+    rel="icon"
+    type="image/svg+xml"
+    href="/play.svg"
+  />
+  <meta
+    name="viewport"
+    content="width=device-width, initial-scale=1.0"
+  />
+  <title>Vite App</title>
+</head>
+
+<body>
+  <div id="app"> </div>
+
+  <script
+    type="module"
+    src="/src/main.js"
+  ></script>
+</body>
+
+</html>