V2 migration

.github/workflows/build.yaml

@@ -5,33 +5,42 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
+
+permissions:
+  contents: write
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [22.x]
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
-
-    - name: Deploy to GitHub Pages
-      if: github.ref == 'refs/heads/main'
-      uses: peaceiris/actions-gh-pages@v4
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./dist
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build --if-present
+
+      - name: Test
+        run: npm test
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist

README.md

@@ -1,25 +1,19 @@
-# ProvenanceWidgets Showcase
-A Showcase of Applications Developed using ProvenanceWidgets.
+# SuperProvenanceWidgets (SW) Showcase
+A showcase of applications developed using SuperProvenanceWidgets, the second generation of ProvenanceWidgets.
 
 ## Setup
 - Open the command line/terminal on your machine and navigate to this project's top-level directory (i.e. where this file is).
-- Download and install node, npm from https://nodejs.org/en/download/. Optionally, use the <a href="https://github.com/nvm-sh/nvm" target="_blank">nvm (Node Version Manager)</a> to quickly install and use different versions of node via the command line. Note the compatible node/npm version in package.json > "engines".
-- Install compatible Angular `npm install -g @angular/cli@15.2.9`
-- `npm install` - installs required libraries from package.json. 
+- Download and install node, npm from https://nodejs.org/en/download/. Optionally, use the <a href="https://github.com/nvm-sh/nvm" target="_blank">nvm (Node Version Manager)</a> to quickly install and use different versions of node via the command line. Note the node version used by the CI workflow (`.github/workflows/build.yaml`), which builds with Node 22.x. Vite 6 requires Node 18 or newer.
+- `npm install` - installs required libraries from package.json.
 
 ## Run
 - `npm run start`
-- Open the browser (preferably Chrome) at [http://localhost:4200](http://localhost:4200).
+- Open the browser at [http://localhost:5173/showcase](http://localhost:5173/showcase).
 
 ## Test
-- `npm run test`
+- `npm run test`.
 
 ## Build
-- `npm run build` outputs the build in the `./dist/` folder.
+- `npm run build`.
 
-## Deployment
-- GitHub Actions is setup via the `.github/workflows/build.yaml` file. Built files are pushed to `gh-pages` branch and served via GitHub Pages at [https://provenancewidgets.github.io/showcase](https://provenancewidgets.github.io/showcase).
 
-## Development vs. Building Configurations for base-href
-- Development: Because the app served from `/` while developing locally, index.html must be configured with `<base href="/" />` and `src/app/applications/home/component.ts` must have the `url` set to `${window.location.origin}/#/${route};`.
-- Build: Because the app is eventually served from `/showcase` (and not `/`), index.html must be configured with `<base href="/showcase/" />` and `src/app/applications/home/component.ts` must have the `url` set to `${window.location.origin}/showcase/#/${route};`. In addition, we pass `--base-href /showcase/` in the `ng build` command (already configured to do this as part of `npm run build`, see package.json).

index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>ProvenanceWidgets | Showcase</title> 
+</head>
+
+<body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+</body>
+
+</html>