Merge pull request #17 from VectorInstitute/improve_catalog_website

Improve catalog website with fuzzy search

Author: amrit110

.github/workflows/code_checks.yml

@@ -35,7 +35,7 @@ jobs:
         uses: astral-sh/setup-uv@0c5e2b8115b80b4c7c5ddf6ffdd634974642d182
         with:
           # Install a specific version of uv.
-          version: "0.5.21"
+          version: "0.8.22"
           enable-cache: true
 
       - name: "Set up Python"
@@ -52,6 +52,8 @@ jobs:
           pre-commit run --all-files
 
       - name: pip-audit (gh-action-pip-audit)
-        uses: pypa/gh-action-pip-audit@1220774d901786e6f652ae159f7b6bc8fea6d266
+        uses: pypa/gh-action-pip-audit@v1.1.0
         with:
           virtual-environment: .venv/
+          ignore-vulns: |
+            GHSA-4xh5-x5gv-qwph

.github/workflows/deploy-catalog.yml

@@ -0,0 +1,76 @@
+name: Deploy Next.js Catalog to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'catalog/**'
+      - 'repositories/**'
+      - 'scripts/sync_repositories_to_json.py'
+      - '.github/workflows/deploy-catalog.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: catalog/package-lock.json
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.8.22"
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Python dependencies
+        run: uv pip install --system pyyaml
+
+      - name: Sync YAML repositories to JSON
+        run: python scripts/sync_repositories_to_json.py
+
+      - name: Install Node dependencies
+        working-directory: catalog
+        run: npm ci
+
+      - name: Build Next.js site
+        working-directory: catalog
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: catalog/out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/docs.yml

@@ -19,3 +19,12 @@ wheels/
 
 # macos
 *.DS_Store
+
+# Next.js
+catalog/.next/
+catalog/out/
+catalog/node_modules/
+catalog/.env*.local
+
+# MkDocs
+site/

.github/workflows/sync_repos.yml

@@ -2,14 +2,42 @@
 
 # Implementation Catalog
 
-This catalog is a collection of repositories for various Machine Learning techniques and algorithms implemented at Vector Institute. The table has the following columns:
-- **Repository**: Link to the Github repo.
-- **Description**: A brief introduction to the repository stating its purpose and links to published research papers.
-- **Algorithms**: List of ML algorithms demonstrated in the repo.
-- **No. of datasets**: Total number of datasets utilized in the repo.
-- **Datasets**: Links to any publicly available data. This is a subset of the total datasets mentioned in the repo.
-- **Type**: The type of implementation (bootcamp, tool, or applied-research).
-- **Year**: The year the implementation was published.
+> **🚀 New!** This catalog now has a modern web interface built with Next.js. Visit the live site at [vectorinstitute.github.io/implementation-catalog](https://vectorinstitute.github.io/implementation-catalog)
+
+This catalog is a collection of repositories for various Machine Learning techniques and algorithms implemented at Vector Institute.
+
+## 🌐 Web Interface
+
+The catalog is available as an interactive website featuring:
+- **Fast Search**: Instant client-side search powered by Pagefind
+- **Filtering**: Browse by type (applied-research, bootcamp, tool)
+- **Responsive Design**: Works on all devices
+- **Static Deployment**: Zero backend, hosted on GitHub Pages
+
+### Local Development
+
+```bash
+# Navigate to the catalog directory
+cd catalog
+
+# Install dependencies
+npm install
+
+# Run development server
+npm run dev
+```
+
+See [`catalog/README.md`](catalog/README.md) for detailed documentation.
+
+## 📋 Repository Information
+
+The catalog contains the following information for each implementation:
+- **Repository**: Link to the Github repo
+- **Description**: Brief introduction and links to published research papers
+- **Algorithms**: ML algorithms and techniques demonstrated
+- **Datasets**: Links to publicly available datasets
+- **Type**: Classification (bootcamp, tool, or applied-research)
+- **Year**: Publication year
 
 | <div style="width:100px">Repository</div> | <div style="width:290px">Description</div> | <div style="width:150px">Algorithms</div>  | <div style="width:60px">No. of<br/>datasets</div> | <div style="width:120px">Public<br/>Datasets</div> | <div style="width:60px">Type</div> | <div style="width:60px">Year</div> |
 | :--------- | :---------- | :--------- | :--------------------:| :-------: | :-------: | :--------: |

.gitignore

@@ -0,0 +1,41 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts